Library › Coding AI › Software developers

Write a PR description in your team's template

Practice: Asking for a format you can use. About 5 minutes.

About this exercise

Write the pull request description for this payment fix. First line 'PAY-512: <title under 60 characters>', then the headings ### What, ### Why and ### Testing in that order. Why must say what only you know: on Oct 30 a timeout retry charged 14 customers twice. Testing is exactly 3 numbered steps. The last line is 'Risk: low', 'Risk: medium' or 'Risk: high' plus a reason under 12 words. No code blocks, under 150 words.

Common mistakes when you ask AI for this

  • The AI's own template. The AI invents headings like Summary, Changes and Checklist. Try: Show it: "First line PAY-512: <title>, then ### What, ### Why, ### Testing."
  • Leaving out the real impact. The diff doesn't say who was affected; only you know about the 14 customers. Try: Add: "Why: on Oct 30 a timeout retry charged 14 customers twice."
  • A sprawling test plan. The AI lists 6 to 10 testing bullets or a code block of commands. Try: Add: "Testing: exactly 3 numbered steps. No code blocks."
  • No risk line. Reviewers on your team look for the risk line first, and the AI won't add one. Try: Add: "End with 'Risk: low|medium|high' plus a short reason."

What a strong prompt includes

  • Gives the first line
  • Lists the headings
  • Adds the impact
  • Sets the test steps
  • Asks for a risk line

Practice this now ↑

Related exercises