How do I set a default PR template on GitHub?

Create a file at .github/pull_request_template.md in your default branch. GitHub pre-fills this content into the description field whenever a new pull request is opened.

How long should a PR description be?

Long enough for a reviewer to understand what changed and why without reading every line of code. A few sentences plus a bulleted list of key changes is ideal. Large refactors warrant longer explanations.

Can I have multiple PR templates?

Yes. Place multiple Markdown files in .github/PULL_REQUEST_TEMPLATE/ and append ?template=filename.md to the PR URL to pre-fill a specific template.

Pull Request Description Template

A consistent pull request template speeds up code review by ensuring authors include a summary of changes, the motivation behind them, and a test plan. This template uses a type-of-change checklist, a description section, and a reviewer checklist covering tests, documentation, and breaking changes. Store it at .github/pull_request_template.md to have GitHub pre-fill every new PR. The Markdown previewer confirms the checklist and heading formatting before you commit the template.

Example

## Summary

Brief description of what this PR does and why.

## Type of Change

- [ ] Bug fix (non-breaking)
- [ ] New feature (non-breaking)
- [ ] Breaking change
- [ ] Documentation update
- [ ] Refactoring (no functional change)

## Changes Made

- List the key changes
- Include any architectural decisions

## Test Plan

- [ ] Unit tests added/updated
- [ ] Integration tests pass
- [ ] Manually tested in dev environment

## Checklist

- [ ] Code follows project style guide
- [ ] Self-review completed
- [ ] Documentation updated if needed
- [ ] No new warnings introduced

[ open in Markdown Previewer → ]

FAQ

How do I set a default PR template on GitHub?: Create a file at .github/pull_request_template.md in your default branch. GitHub pre-fills this content into the description field whenever a new pull request is opened.
How long should a PR description be?: Long enough for a reviewer to understand what changed and why without reading every line of code. A few sentences plus a bulleted list of key changes is ideal. Large refactors warrant longer explanations.
Can I have multiple PR templates?: Yes. Place multiple Markdown files in .github/PULL_REQUEST_TEMPLATE/ and append ?template=filename.md to the PR URL to pre-fill a specific template.

Related Examples

GitHub Issue Template in Markdown

Well-structured issue templates dramatically improve the quality of bug reports ...

Write a CONTRIBUTING Guide

A contributing guide reduces friction for new contributors by explaining how to ...

Write a CHANGELOG in Markdown

A structured changelog tells users what changed between versions and why, buildi...