You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Hold the README and CONTRIBUTING to the repository with a test #69
A test that holds the README and CONTRIBUTING.md to the repository, so the first documents a reader opens cannot quietly drift from it.
Prose goes stale silently: a renamed script, a coverage threshold that moved, a pinned Node version that changed. Each of those reads exactly as well wrong as right, and a new contributor follows the wrong one.
Claims worth holding:
Every npm script the documents tell a reader to run exists in package.json.
The coverage numbers the documents quote match the thresholds in the Vitest config.
The Node version the documents tell a contributor to install matches .nvmrc.
Every path the documents name as a file or directory exists.
The link gate already checks that relative links and heading anchors resolve, so this test covers the claims it cannot see: names, numbers and versions.
Acceptance criteria
Renaming a script the README names fails the test, and the failure names the document and the claim.
Changing a coverage threshold without updating the documents fails it.
Changing the pinned Node version without updating the documents fails it.
A clean tree passes, and the test has claims to check rather than passing over an empty list.
Activity
test: hold README and CONTRIBUTING to the repository they describe (#72)