Pull Request Checklist
Overview
Use this checklist to make reviews faster and safer.
Why It Matters
A good PR checklist improves diff quality and reduces back-and-forth.
Core Concepts
- Clear summary.
- Focused changes.
- Verification steps included.
Mental Models
The PR should tell the story well enough that the reviewer can focus on quality, not context gathering.
Best Practices
- Remove unrelated changes.
- Include testing notes.
- Explain the why when the change is non-obvious.
Common Mistakes
- Shipping too much in one PR.
- Leaving no test instructions.
- Assuming the reviewer knows the background.
Trade-offs
Very small PRs are easier to review, but splitting work too far can also create overhead.
Decision Framework
| Item | Check |
|---|---|
| Scope | Focused and intentional |
| Testing | Clear verification steps |
| Risk | Mentioned and mitigated |
Examples
- “Reproduced with cached auth state.”
Checklists
- Is the summary clear?
- Did I include how to test?
- Are unrelated files excluded?
Senior Engineer Notes
Senior engineers optimize PRs for human review time. The goal is to make the right change obvious.