Standard GitHub Pull Request Template
A well-rounded GitHub PR template with description, type of change checkboxes, checklist, testing, and related issues sections. Ideal for most repositories.
Detailed Explanation
Standard GitHub Pull Request Template
The standard PR template is the most commonly used format across GitHub repositories. It strikes a balance between capturing enough context for reviewers and not overwhelming contributors with too many fields.
Template Structure
## Description
<!-- Please include a summary of the changes and the related issue. -->
## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
## Checklist
- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my code
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
## Testing
<!-- Please describe the tests you ran to verify your changes. -->
## Related Issues
<!-- Fixes #(issue number) -->
Key Sections Explained
Description uses HTML comments as invisible placeholder text. Contributors see the guidance when editing but reviewers see clean Markdown after submission.
Type of Change uses GitHub-flavored checkbox syntax (- [ ]). Contributors can check boxes by replacing the space with an x (- [x]), or by clicking the rendered checkboxes directly in the GitHub UI.
Checklist ensures code quality gates are met before review. Common items include style compliance, self-review, documentation updates, and test coverage.
File Location
Save this file as .github/pull_request_template.md in your repository root. GitHub automatically loads it when a new PR is opened. The template content pre-fills the PR description field.
Customization Tips
- Add project-specific checklist items like "I have updated the CHANGELOG" or "Database migrations are backward-compatible"
- Include links to your coding standards or contribution guide
- Keep the template concise — overly long templates discourage contributors from filling them out properly
Use Case
Setting up a new GitHub repository's first PR template, or standardizing the PR process across a team that has been submitting unstructured PR descriptions.