docs: sync README + AGENTS after v0.1.1#23
Merged
brettdavies merged 3 commits intodevfrom Apr 21, 2026
Merged
Conversation
- README: refresh sample dogfood output (26 pass / 2 warn matches current state; was 20 pass / 8 warn pre-v0.1.1 P1 gate fix). - AGENTS: 'Adding a New Check' now calls out the `covers()` declaration and the coverage-matrix regeneration step that landed in v0.1.1. Project Structure lists `src/principles/registry.rs` and `src/principles/matrix.rs`. Cross-references CLAUDE.md for the full registry conventions.
The JSON example showed a v1.0 scorecard shape (no schema_version, no coverage_summary, stale summary counts). Refreshed to match what anc actually emits in v0.1.1: - Add `schema_version: "1.1"` at top level. - Add `coverage_summary` block with MUST/SHOULD/MAY × total/verified counts against the spec registry. - Refresh summary counts (26 pass / 2 warn) to match post-P1-gate-fix behaviour. - Document `audience` and `audit_profile` as reserved v0.1.3 fields with a feature-detection note for consumers. Same PR as the README sample output + AGENTS covers() update. Both sweeps target v0.1.1 surface area.
Seven issue templates landed in v0.1.1 (false-positive, scoring-bug, feature-request, grade-a-cli, pressure-test, spec-question, plus a chooser). README had no discoverability into them — folks filing issues would default to a blank 'Something else' form. Added a short 'Reporting issues' subsection under Contributing that links to /issues/new/choose and tabulates when to reach for each template. Keeps the routing context front-loaded where users actually look for it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Small post-release doc sync against what actually shipped in v0.1.1.
Not tied to the next release — lands on `dev` for the next release
branch to cherry-pick whenever it cuts.
Two files touched:
`README.md` — refreshed the sample dogfood output. The block at
line 82 showed `30 checks: 20 pass, 8 warn, 0 fail, 2 skip, 0 error`,
which was accurate pre-v0.1.1. After the P1 applicability gate fix
landed, current state is `30 checks: 26 pass, 2 warn, 0 fail, 2 skip,
0 error`. Just the sample output; check count and structure unchanged.
`AGENTS.md` — closed a real drift. The "Adding a New Check"
section listed the `Check` trait methods as `id()`, `group()`,
`layer()`, `applicable()`, `run()` — missing `covers()` which
landed in v0.1.1. New contributors adding a check without `covers()`
would silently not appear in the coverage matrix. Also added the
`cargo run -- generate coverage-matrix` regeneration step. Project
Structure list gained `src/principles/registry.rs` and
`src/principles/matrix.rs`. Cross-references CLAUDE.md for the full
conventions (registry rules, drift detector, artifact lifecycle).
Changelog
Documentation
regeneration step in the "Adding a New Check" guide.
Type of Change
Related
`covers()`, `src/principles/registry.rs`, and `anc generate coverage-matrix`.
this PR just makes AGENTS.md point at them so contributors hit it from the right entry doc.
Testing
Files Modified