Documentation
README
Brooks-Lint — PR Review
Setup
Read in order:
../_shared/common.md— Iron Law, Project Config, Report Template, Health Score../_shared/source-coverage.md— book coverage, exceptions, tradeoffs../_shared/decay-risks.md— symptom definitions and source attributionspr-review-guide.md(this directory) — the analysis process
Process
Scope: if the user did not specify files or paste code, apply Auto Scope Detection
(../_shared/common.md) first.
- Understand the review scope, then scan for each decay risk in the order specified (Steps 1–6 of the guide)
- Run the Quick Test Check (Step 7 of the guide) — skip for docs-only or non-production changes
- Apply the Iron Law to every finding
- Output using the Report Template from common.md
This is the opening of the README. Read the full README on GitHub.