Pull Request Template (Markdown)
A consistent format for GitHub pull requests. Helps reviewers understand what changed, why, and what testing was done.
## Description
What does this PR do? Why is it needed?
Fixes #issue_number
## Changes
- Change one
- Change two
- Change three
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
## Testing
- [ ] Unit tests pass
- [ ] Manual testing done
## Screenshots
[Before/after if UI change]
## Checklist
- [ ] Code follows style guide
- [ ] Self-reviewed
- [ ] Documentation updated
What Makes a Good PR Description
A pull request description should answer two questions: what changed and why. The ## Description section covers the motivation. The ## Changes list covers the implementation.
Include screenshots for UI changes. A before/after pair is worth a thousand words of explanation. If the PR fixes a specific issue, link it with "Fixes #123" so GitHub auto-closes it on merge.
The checklist helps reviewers confirm you've covered the basics. Customize it for your team's standards.
Related Developer Templates
Bug Report Template — Report issues
Feature Request Template — Propose new features
Code Review Template — Review feedback format
Release Notes Template — Announce releases