Pull Request Template
A reusable PR description template that makes reviews faster and kinder.
~1 min read updated Jul 17, 2026 Templates
#git #github #template #collaboration
Drop this in .github/pull_request_template.md and every PR opens pre-filled.
Good descriptions get reviewed faster because the reviewer knows what to look
for.
The template
.github/pull_request_template.md
## What & why
<!-- What does this change do, and why is it needed? Link the issue. -->
Closes #
## How to test
<!-- Steps for the reviewer to verify this works. -->
1.
2.
## Screenshots
<!-- For any UI change. Before / after if relevant. -->
## Checklist
- [ ] Tests added or updated
- [ ] Self-reviewed the diff
- [ ] No debug logging left behind
- [ ] Docs updated if behavior changed
The "How to test" section is the one reviewers value most — it turns "looks fine
to me" into an actual verification. Make it required in your team norms.
Keep it short. A template nobody fills in is worse than none. Five prompts is
plenty; trim to what your team actually reads.
Templates
Reusable starting points for files, configs and docs.
Meta
How this knowledge base itself is built and maintained.