Example result: Write a pull request description reviewers love
AI-generated example · PR Description
Updated

Write a pull request description reviewers love

This prompt turns your diff and notes into a short, scannable pull request description. It covers what changed and why, how to test it, and where reviewers should look closely.

text-code-pr-description-writer — claude — 76 words

Act as a senior developer writing a pull request description.

What the PR does: [SHORT SUMMARY]
Why: [THE PROBLEM OR TICKET]
Diff or list of changes:
[PASTE]
How I tested it: [e.g. unit tests, manual checks]

Write a description with: a two-line summary, why the change is needed, a list of the main changes, how to test it, screenshots needed (if UI), and risks or things reviewers should look at closely. Keep it scannable and short.

Tell reviewers where to look first. A good "please check this part" saves everyone time.

Get a better result

What you will get

A pull request description with a two-line summary, the reason for the change, a bullet list of main changes, test steps, screenshot notes for any UI work and a short list of risky areas to review first.

Common mistake

It describes every file in the diff.

Fix: Ask for changes grouped by behaviour, not by file. Reviewers need what changed for users and callers.

Also watch for
  • The risks section is empty or generic. Tell it which part you are least sure about, such as a migration or a retry loop, so it can point reviewers there.
  • It claims tests that you did not run. List only what you actually ran. Delete any “tested on” line you cannot back up.
Try a variation: add a rollback note

Ask for a final line explaining how to undo the change safely if it causes trouble after release.

Still not right? Reply with this

Keep the layout. Make the “please check this first” line name one file and one function, and say why they matter.

Guides on this topic

More chat & writing prompts

See all 465 →