Template
## What
Short summary of the change.
## Why
Problem or ticket link (Fixes #123).
## How to test
1. Steps the reviewer can follow.
## Notes for reviewers
Where to look closely, trade-offs, follow-ups.
Three samples
| Example | What it means |
|---|---|
| Adds pagination to the orders endpoint. Large accounts were timing out (Fixes #482). Test with ?page=2&limit=50. | Feature |
| Fixes the crash when the cart is empty. The total was read before the null check. Added a regression test. | Bug fix |
| Refactors the auth middleware into smaller functions. No behavior change; tests pass as before. | Refactor |
Phrases for PRs
| Example | What it means |
|---|---|
| This PR adds… | Opening line |
| This is a first pass; feedback welcome. | Early version |
| Out of scope: …, will follow up in a separate PR. | Limit the scope |
| Draft / WIP: not ready for review yet. | Work in progress |
GitHub can pre-fill descriptions from .github/pull_request_template.md; Graphite collects templates. See also code review comments.
Learn the phrases, not just the words
Devlingo, Gambit Studio's English for developers app, has over 3,600 phrases for daily standups, code review, Slack, email, meetings and pull requests, ten new ones a day with real context and pronunciation, and a widget with the phrase of the day.