Write the PR description reviewers stop asking questions about
Submitted by Max
Added today
Here's my diff: {{paste git diff or the file list plus key hunks}}. The ticket said: {{paste it}}.
Write the pull request description with these sections:
1. WHAT CHANGED — two sentences, in behaviour terms, not file terms.
2. WHY — the problem this solves and what happens if we don't merge it.
3. HOW TO REVIEW — the order to read the files in, and the two or three lines that actually deserve scrutiny.
4. HOW TO TEST — exact steps or commands, including the state you need to set up first.
5. RISK — what breaks if this is wrong, and how we'd notice.
6. NOT IN THIS PR — anything a reviewer will ask about that I deliberately left out.
Rules: no bullet that restates a filename. If the diff contains something the ticket didn't ask for, call it out under its own heading rather than burying it.
How to use it
Section 6 saves the most time. Most review round-trips are a reviewer asking why something obvious is missing.
Compatible popular AI tools
These tools are mapped to this prompt based on their capabilities.
People who liked this prompt
2 community likes