How to Write a Great AI Prompt to Write a Pull Request Description
Most people ask AI to "Write a PR description for my code change"—and wonder why the output is mediocre. Here's how to write a prompt that actually gets you what you want on the first try.
"Write a PR description for my code change"
Too vague—AI has to guess what you want
"Write a pull request description for the following code change. Include: what this PR does (2 sentences), why it was needed, what approach was taken and why alternatives were rejected, how to test it, and any risks or follow-up work. Use bullet points for the testing and risk sections. Assume the reviewer is a senior engineer."
Specific, clear, ready to use
What makes the strong prompt better?
Asks for the 'why' not just the 'what', which is what reviewers actually need
Requesting rejected alternatives shows engineering judgment
Specifying reviewer level ensures appropriate technical depth
Pro tips for write a pull request description prompts
- •Always specify your target audience or reader
- •Include concrete examples or context from your situation
- •Set tone guidance—formal, casual, witty, empathetic
- •Add length constraints to avoid rambling output
- •Exclude what you don't want (e.g., "no buzzwords", "no clichés")
Related prompt templates
Ready to build your perfect prompt?
Try Prompt Orange free—get a scored, refined prompt in under 2 minutes. No signup required.
Build my prompt now