A pull request template is a reusable outline of questions and checklist items that appears when someone opens a pull request. It helps authors provide context, links, labels, tests, and other preparation details without relying on memory; reviewers receive more consistent information and spend less time requesting basics. section 5.4.1
Use templates as a practical starting point, then adapt them to the change:
- Create a Markdown file named pull_request_template.md at the repository root so pull requests receive it automatically. section 5.4.1
- Choose different templates for different work, such as new features, bug fixes, documentation updates, or a standard change. section 5.4.1
- Keep human acknowledgments meaningful: remove checklist items when an automated check has replaced them and provides equivalent coverage. section 3.4.1
- Treat the template as a team practice rather than a complete automation system; authors still need to answer and acknowledge its items. section 5.4.1
Bug-fix template
A focused bug-fix template asks what is happening, how to reproduce it, what caused it, why the fix works, how it was tested, what it affects, and whether regression risk remains. Its checklist can require an issue link and local testing, giving reviewers a concise path from symptom to verification. section 5.4.1
Listing 5.10 New feature PR template (simple example)
- [ ] Description – Why is this change being made? (Please add any relevant context, history, or decisions related to this feature): - [ ] Linked Work Ticket/Issue # - [ ] Linked Documentation: - [ ] New Feature label assigned - [ ] Accompanying unit tests included - [ ] Minimum of 2 reviewers assigned
The simple new-feature template demonstrates a compact checklist covering rationale, work tracking, documentation, labeling, unit tests, and reviewer assignment. section 5.4.1
