Code review checklist documented
Why it matters
Without a PR template or documented code review checklist, review quality is entirely reviewer-dependent — type safety checks, test coverage verification, and breaking change documentation happen only when a reviewer happens to think of them. ISO 25010:2011 §6.5.3 classifies undocumented review processes as a maintainability defect. PR templates enforce a minimum bar on every PR: the author must explicitly confirm that tests pass, lint is clean, and breaking changes are documented — reducing the rate of issues that slip through to main.
Severity rationale
Info because absent PR templates do not break functionality but allow preventable defects to ship through code review gaps that a checklist would have caught.
Remediation
Add a pull request template at .github/PULL_REQUEST_TEMPLATE.md. It pre-populates every new PR description with the checklist, so authors must actively uncheck items rather than passively forgetting them.
<!-- .github/PULL_REQUEST_TEMPLATE.md -->
## Summary
Brief description of the change and why it was made.
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Refactor
- [ ] Documentation
## Checklist
- [ ] No new TypeScript errors (`npm run build` passes)
- [ ] Tests added or updated for changed logic
- [ ] `npm run lint` passes with no warnings
- [ ] No `console.log` or `@ts-ignore` added without comment
- [ ] Breaking changes documented in PR description
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Code Quality Essentials Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · maintainability.modifiability — Maintainability — Changeability
- soc2:2017 · CC8.1 — Change management
Taxons
History
- 2026-04-18·v1.0.0·Initial import from code-quality-essentials·automated
- 2026-07-06·v1.0.1·Add SOC 2 TSC mapping (CC8.1) from the verified compliance crosswalk register (docs/compliance/).·by soc2-mapping-enrichment-ship-2