Skip to content

Keep evidenced registry badges and docs links when they cannot be checked - #30

Merged
pekral merged 1 commit into
masterfrom
fix/23-keep-evidenced-badges
Nov 12, 2026
Merged

pekral merged 1 commit into
masterfrom
fix/23-keep-evidenced-badges

Conversation

@pekral

@pekral pekral commented Nov 12, 2026

Copy link
Copy Markdown
Owner

What this changes

In update mode, a registry badge or documentation link the existing README already carries now counts as evidence when its slug matches the manifest. It is kept and reported as kept but unverified when the registry or site cannot be reached, instead of being dropped. A documented package keeps only its first example in Quick start and delegates the rest to that docs link.

Closes #23

Why

Scenario 1 ran offline and dropped the Packagist version and downloads badges because publication could not be confirmed, and removed the docs link while writing its mechanics inline. The evidence policy did not count the maintainer's own README as evidence, so any offline run lost them. A badge or link is now dropped only on evidence against it (a mismatched slug, or a check that ran and failed), never because a check could not run.

Checks

  • node --test tests/repository.test.mjs passes
  • node --test tests/evals/*.test.mjs passes (33/33 together)
  • CHANGELOG.md updated under the current unreleased heading
  • A rule changed in SKILL.md is changed everywhere it appears in references/ (evidence-policy.md, validation-checklist.md, readme-structure.md)
  • Behaviour changes exercised against the affected scenario in
    tests/scenarios.md, and the run recorded in its
    host coverage log

Claims this adds to the documentation

  • Scenario 1 now passes under Claude Code 2.1.322 (claude -p "Update the README for this repository." --permission-mode acceptEdits --setting-sources project, skill copied into the workspace). Evidence: the badge row is version, license, Tests, downloads with the acme/slugger slug; Quick start holds the first example alone; the docs link is kept as ## Documentation; the handover names the Packagist badges and docs link as unverified. An intermediate run with only the evidence-policy change kept the badges and link but still inlined a second example and a mechanics paragraph, which is why the documented-package rule was tightened too.

@pekral
pekral force-pushed the fix/23-keep-evidenced-badges branch from f3d0c45 to caeb8b6 Compare November 12, 2026 13:33
@pekral
pekral merged commit ecb4626 into master Nov 12, 2026
2 checks passed
@pekral
pekral deleted the fix/23-keep-evidenced-badges branch November 12, 2026 13:33
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 1: keep evidenced registry badges and delegate to the docs link

1 participant