Guide · Devlingo

Pull request description example and template

Quick answer

A good pull request description example answers four things: what changed, why, how to test it and what the reviewer should look at. “Adds retry with backoff to the payment webhook, because 3% of events failed on timeouts. Test: run the webhook suite.” Devlingo has a full Pull Requests category.

Updated 2 min readGambit Studio

Use without installing →Free in your browser, no sign-up

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

ExampleWhat 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

ExampleWhat 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.

Sources

  1. Graphite: pull request description templates

Frequently asked questions

What people ask most about this, answered with the source.

What should a pull request description include?
What changed, why, how to test it and notes for reviewers.
How long should a PR description be?
Long enough that a reviewer understands the change without reading every line; a few short sections.
How do I add a PR template on GitHub?
Create .github/pull_request_template.md in the repository.
DevlingoLearn tech phrases & speaking
Use without installingGet