Skip to content

Bring an existing README to the standard in update mode - #32

Merged
pekral merged 1 commit into
masterfrom
fix/25-update-mode-standard
Nov 12, 2026
Merged

pekral merged 1 commit into
masterfrom
fix/25-update-mode-standard

Conversation

@pekral

@pekral pekral commented Nov 12, 2026

Copy link
Copy Markdown
Owner

What this changes

Update mode brings an existing README to the README standard — header shape, section names and order — while keeping the author's prose and the existing logo. Scenario 5's invariant now expects that, instead of "only the outdated parts change".

Closes #25

Why

#25 recorded a conflict: scenario 5 allowed only outdated commands, links and versions to change, while SKILL.md and the README standard (#17) restructure the header and section names. The maintainer decided the standard wins.

  • SKILL.md Update mode: fix what is outdated, unsupported, or duplicated, and bring the structure to the standard in references/readme-structure.md, keeping the author's prose and logo inside it.
  • tests/scenarios.md scenario 5: the invariant now requires every outdated item fixed and the structure to follow the standard, with no section invented beyond what the repository evidences.

Checks

  • node --test tests/repository.test.mjs passes
  • node --test tests/evals/*.test.mjs passes
  • CHANGELOG.md updated under the current unreleased heading
  • A rule changed in SKILL.md is changed everywhere it appears in references/ — no reference restated the old "only what is outdated" rule
  • Behaviour changes exercised against the affected scenario, and the run recorded in its host coverage log — scenario 5 re-run passes

Claims this adds to the documentation

  • Scenario 5 passes under Claude Code 2.1.322: the logo and the author's paragraph survive verbatim, all five stale items are fixed, the header and sections follow the standard and each is backed by the repository, and only README.md changed. The quick start's colour values were computed by the agent from the code; spot-checked by hand (#336699 → #668cb3 at the second step).

Update mode now fixes what is outdated, unsupported, or duplicated and brings the structure to the README standard, keeping the author's prose and logo. Scenario 5's invariant follows, and its re-run passes. Closes #25.
@pekral
pekral merged commit a9dbd85 into master Nov 12, 2026
2 checks passed
@pekral
pekral deleted the fix/25-update-mode-standard branch November 12, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Scenario 5: decide whether update mode may restructure a stale README

1 participant