docs: the skill stopped contradicting itself about what a SKIP is
SKILL.md's opening list still glossed `SKIP` as "the check could not run" and then contradicted itself five lines later, where 0.8.0 had added the two kinds. A session reading only the list reports every deliberate skip as something that failed to run, and sends someone to fix fixture links that are deliberate on purpose. 0.7.1 exists because 0.7.0 shipped the same class of defect; this is the check that was supposed to stop it happening twice. README's `--offline` note and its bilingual-undecidable paragraph now name which kind their skips are, and what resolves them. Both were true and incomplete — incomplete in the one direction that matters now that the summary line names only one of the two. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DHaQTcaD3w2C6PqVsAmrcv
This commit is contained in:
parent
f4017bcfe1
commit
9a566240e8
5 changed files with 31 additions and 9 deletions
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "repo-standard",
|
||||
"version": "0.8.0",
|
||||
"version": "0.8.1",
|
||||
"description": "Per-repo gate for the open/ presentation standard: README first screen, install block, files required by the repo's class, and dead repo references.",
|
||||
"author": {
|
||||
"name": "Kjell Tore Guttormsen"
|
||||
|
|
|
|||
19
CHANGELOG.md
19
CHANGELOG.md
|
|
@ -4,6 +4,25 @@ 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.8.1] — 2026-08-09
|
||||
|
||||
### Fixed
|
||||
|
||||
- `SKILL.md` glossed `SKIP` as "the check could not run" in its opening list and
|
||||
then contradicted itself five lines later, where 0.8.0 had added the two
|
||||
kinds. A session reading only the list would report every `byDesign` skip as
|
||||
something that failed to run, and send someone to fix fixture links that are
|
||||
deliberate. Shipping 0.7.0 without its skill update produced the same class of
|
||||
defect; this is the check that was supposed to stop it happening twice.
|
||||
|
||||
- README's `--offline` note said the dependent checks "report `SKIP`, not `OK`"
|
||||
without saying which kind, now that the summary line only names one of them.
|
||||
They are `notRun` and clear on a networked re-run — an offline pass is never a
|
||||
fully judged one, which is the whole reason the qualifier exists.
|
||||
|
||||
- README's bilingual-undecidable paragraph likewise names its kind, and the
|
||||
action that resolves it.
|
||||
|
||||
## [0.8.0] — 2026-08-09
|
||||
|
||||
### Added
|
||||
|
|
|
|||
13
README.md
13
README.md
|
|
@ -10,7 +10,7 @@ checks that surface in one repository and reports what it finds.
|
|||
|
||||
*AI-generated: all code produced by Claude Code through dialog-driven development.*
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
|
@ -45,6 +45,8 @@ Node 18 or newer. No dependencies. Two network calls: the org listing (for a
|
|||
repo's published description) and the catalog manifest (to confirm the install
|
||||
command resolves). Both read anonymously, so no token is needed, and `--offline`
|
||||
skips both — the checks that depended on them then report `SKIP`, not `OK`.
|
||||
Those land as `notRun` and clear on a networked re-run, so an offline pass is
|
||||
never a fully judged one.
|
||||
|
||||
## What it does
|
||||
|
||||
|
|
@ -104,9 +106,9 @@ declines to judge on purpose.
|
|||
The summary line names only what someone has an action on:
|
||||
|
||||
```
|
||||
✓ portfolio-optimiser [standalone] — OK (repo-standard v0.8.0 @<sha>)
|
||||
✗ some-plugin [plugin] — ERROR · 2 not run (repo-standard v0.8.0 @<sha>)
|
||||
· stranger — SKIP · 1 not run (repo-standard v0.8.0 @<sha>)
|
||||
✓ portfolio-optimiser [standalone] — OK (repo-standard v0.8.1 @<sha>)
|
||||
✗ some-plugin [plugin] — ERROR · 2 not run (repo-standard v0.8.1 @<sha>)
|
||||
· stranger — SKIP · 1 not run (repo-standard v0.8.1 @<sha>)
|
||||
```
|
||||
|
||||
The deliberate ones are not silenced: they keep their own `NOT JUDGED` heading
|
||||
|
|
@ -138,7 +140,8 @@ Detection is a stopword-frequency comparison over prose with code stripped, so a
|
|||
Norwegian flag name in a shell example cannot decide what the document is. It
|
||||
answers which language dominates and nothing else: a README can pass this and
|
||||
still be badly written. Where the prose is too evenly bilingual to call, the
|
||||
finding is a `SKIP` — the question is live and unanswered. Where there is no
|
||||
finding is a `SKIP`, and a `notRun` one — the question is live and unanswered,
|
||||
and fixing the prose or the register's `locales` entry answers it. Where there is no
|
||||
running prose at all, it is an `OK`: nothing claims a language, and a thin README
|
||||
is the first-screen check's business, not this one's.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "repo-standard",
|
||||
"version": "0.8.0",
|
||||
"version": "0.8.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"engines": {
|
||||
|
|
|
|||
|
|
@ -25,8 +25,8 @@ the script cannot encode.
|
|||
|
||||
node "${CLAUDE_PLUGIN_ROOT}/scripts/repo-standard-check.mjs" --dir "$PWD"
|
||||
|
||||
Findings are `ERROR` (blocks), `WARN` (look, then decide), `SKIP` (the check
|
||||
could not run), `OK`. Exit 1 on any ERROR. Add `--offline` to skip the two
|
||||
Findings are `ERROR` (blocks), `WARN` (look, then decide), `SKIP` (not judged —
|
||||
in one of two ways, see below), `OK`. Exit 1 on any ERROR. Add `--offline` to skip the two
|
||||
network calls, `--json` for machine output, `--refresh` to compare the bundled
|
||||
register against the live org listing.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue