Skip to content

docs(agents): require skill review and the CRAP report before review - #56

Merged
thebrandonlucas merged 1 commit into
masterfrom
docs/agents-review-checks
Oct 20, 2026
Merged

thebrandonlucas merged 1 commit into
masterfrom
docs/agents-review-checks

Conversation

@thebrandonlucas

Copy link
Copy Markdown
Contributor

Problem

Two required checks are easy to skip because CI runs neither:

  • The skill review. voltage-pr-review (engineering-skills) reviews the diff against its base and the repository's rules.
  • The CRAP report. docs/quality.md requires every measured function to stay below 20, but the check is manual.

On #55, a human review found a CRAP violation (startup::execute at 20.15), a hand-written match where Display belonged, and two untested error paths. Neither the author agent nor a review agent had run these checks.

Change

AGENTS.md gets a "Before you request review" section, for authors and reviewers, people or agents:

Step Check
1 Review the diff with voltage-pr-review; for Rust, also voltage-backend-engineering and its style checklist. Fix findings first.
2 Test every new error and early-return path.
3 Run the gate in docs/development.md.
4 For changes under src/ or tests/, run the CRAP report: every function below 20. Fix a violation in the PR that introduces it, without splitting functions only for the score.
5 Report the checks that ran and the CRAP result (highest score and each function at or above 20) in the PR description.

A reviewer runs the CRAP report on the PR head and reports violations as findings.

Validation

Docs only (+23 lines). master has no docs link test yet, so I checked by hand that docs/development.md exists and that docs/quality.md has a ### CRAP risk check heading (anchor #crap-risk-check). The CRAP report does not apply, because the change touches neither src/ nor tests/.

CI runs neither the voltage-pr-review skill's diff review nor the manual
CRAP report, so both were easy to skip. AGENTS.md now lists the checks
that authors and reviewers, people or agents, run before a pull request
is ready: the skill review against the base, tests for every new error
path, the development guide's gate, and the CRAP report for changes
under src/ or tests/. The pull request reports what ran and the CRAP
result.
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.

2 participants