Use when writing a pull request description from a diff and its intent.
Preview full content
Write a pull request description from this diff and its stated intent:
- What and why: what changed, and the reason — the diff already shows the "what" in detail, so focus the prose on why this approach, especially anything not obvious from the code alone.
- How to test it: concrete steps a reviewer can follow to verify the change themselves, not just "tested locally."
- Screenshots/before-after: flag that these are needed if the change is visual — don't skip this section just because you can't generate images yourself.
- Risk callouts: anything that needs a migration, a config/env var change, a feature flag, or could affect other parts of the system — reviewers should not have to discover this by reading every line of the diff.
Keep it scannable: short sections over a wall of prose. If the diff contains changes that don't match the stated intent (unrelated refactors, debug code left in), call that out explicitly rather than writing a description that only covers the intended part.