Content
86%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The body is a tight, well-structured overview that gives concrete commands and rules without padding, with clean one-level-deep references. It could improve by adding a copy-paste node-rule code example and an explicit validate-fix-retry loop.
Suggestions
Add one complete, copy-paste `FormatNodeRule` / `fmt_fields` example so the node-rules guidance is fully executable rather than principle-level.
Make the feedback loop explicit in the workflow (e.g. 'If snapshots diverge or reformatting fails: fix the IR, re-run `just f`, re-verify convergence') to reach the top workflow_clarity anchor.
Clarify which command runs the narrowest spec test (a concrete invocation) so step 'Run the narrowest formatter crate or spec test first' is directly executable.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean and assumes contributor competence: it never explains what Biome or a formatter is, and every line states a project-specific rule, IR primitive, or command rather than padding with background. | 5 / 5 |
Actionability | Provides executable shell commands (`just gen-formatter <lang>`, `just f`, `just l`, exact prettier-compare invocations) and concrete IR primitives (`space()`, groups), but much of the node-rules and layout guidance is architectural principle rather than copy-paste code, leaving minor gaps. | 4 / 5 |
Workflow Clarity | The Workflow section is a clearly sequenced 1–6 process with checkpoints ('inspect snapshots', 'Review snapshots before accepting them') and a Review Checklist, but it lacks an explicit error-recovery/feedback loop phrased as 'if it fails, fix and re-run'. | 4 / 5 |
Progressive Disclosure | Well-organized into focused sections with a clearly signaled, one-level-deep References block pointing to canonical files (CONTRIBUTING.md, spec.rs, README.md); no nested references and the inline content is appropriately overview-level. | 5 / 5 |
Total | 18 / 20 Passed |