docs: the skill and the README caught up with 0.7.0
Three published documents went out with 0.7.0 unread. SKILL.md told a reader what a SKIP FINDING means and stopped there. Complete before 0.7.0, not now: a repo can headline `OK · 3 not checked`, and a session reporting the status word alone would report a green pass over three unjudged findings. Status and count are now required together. Shipping without this made the plugin whose purpose is catching stale published documents ship one. README's example output cited commits older than the behaviour they demonstrate —5884a64(0.6.0) beside a `notChecked` that did not exist in it, anda7276e6two releases back. The version names a file; only the sha names the code. Both now cite10ad125. README also now states the unit: `notChecked` counts un-judged FINDINGS, not checks. portfolio-optimiser's `11 not checked` is almost entirely LINK-OUTSIDE-REPO, so the bare number reads worse than the repo is. Named as a known limitation, not corrected in the string — the fix is splitting "deliberately not judged" from "could not run", which is the next release.
This commit is contained in:
parent
10ad1254ab
commit
1a647a591f
5 changed files with 45 additions and 6 deletions
26
CHANGELOG.md
26
CHANGELOG.md
|
|
@ -4,6 +4,32 @@ All notable changes to this project are documented here.
|
|||
Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
|
||||
versioning is [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.7.1] — 2026-08-09
|
||||
|
||||
### Fixed
|
||||
|
||||
- The skill told a reader what a `SKIP` finding means and stopped there, which
|
||||
was complete before 0.7.0 and is not now: a repo can headline `OK · 3 not
|
||||
checked`, and a session reporting only the status word would report a green
|
||||
pass over three unjudged findings. `SKILL.md` now requires the status and the
|
||||
count to be reported together. Shipping 0.7.0 without this made the plugin
|
||||
whose purpose is catching stale published documents ship one.
|
||||
|
||||
- README's example output carried commits older than the behaviour they
|
||||
demonstrate — one from 0.6.0 beside a `notChecked` that did not exist in it,
|
||||
one two releases back. This repo's own invariant is that the version names a
|
||||
file and only the sha names the code; the examples now cite `10ad125`, the
|
||||
commit the feature actually shipped in.
|
||||
|
||||
### Added
|
||||
|
||||
- README states the unit of `notChecked`: it counts un-judged **findings**, not
|
||||
checks. A repo with many links leaving it scores a high count without a single
|
||||
check having failed to run, so the bare number reads worse than the repo is.
|
||||
Named as a known limitation rather than corrected in the string — the fix is
|
||||
splitting *deliberately not judged* from *could not run*, which is its own
|
||||
release.
|
||||
|
||||
## [0.7.0] — 2026-08-09
|
||||
|
||||
### Changed
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue