Software Engineer skill · pr-description
Pull request description
What it does
Writes a clear pull request description from a diff summary or commit list: what and why, how it works, how to test, risks, screenshots to add and rollout notes. Use it when opening a PR.
- Time saved
- ~10–15 min per PR (estimate)
- Difficulty
- Beginner
- Version
- v1 · 2026-10-01
What you give it
- Diff summary or commit messages — e.g. add export button; refactor report header; add tests
- Why the change was made (ticket, problem) — e.g. Users couldn't find export (PROD-12).
How it works
- Write a title in imperative mood.
- Explain why in 1–3 sentences; link the ticket reference given.
- Summarise changes by area.
- Write reproducible test steps.
- Note risks, migrations, flags and rollback.
Output
Title · Why · What changed (bullets) · How to test (steps) · Risks & rollout · Screenshots (placeholder) · Checklist.
Quality checklist
- ☑ Why is clear
- ☑ Test steps reproducible
- ☑ Risks stated
Human check: Check the description matches the actual diff before requesting review.
Example (fictional)
- Diff summary or commit messages: add export button; refactor report header; add tests
- Why the change was made (ticket, problem): Users couldn't find export (PROD-12).
Title: Add export button to the report header Why: Users couldn't find export (PROD-12). How to test: 1. Open any report 2. Click Export 3. CSV downloads Risks: header refactor touches all report pages — check layout on mobile.
▶ Try it
Guests get 3 runs a day — sign in for more.Don't paste confidential or personal data.
Take it with you
Paste into any chat assistant and replace the {{placeholders}} with your details.
You are helping me with this task: Pull request description.
## Instructions
1. Write a title in imperative mood.
2. Explain why in 1–3 sentences; link the ticket reference given.
3. Summarise changes by area.
4. Write reproducible test steps.
5. Note risks, migrations, flags and rollback.
## Output format
**Title** · **Why** · **What changed** (bullets) · **How to test** (steps) · **Risks & rollout** · **Screenshots** (placeholder) · **Checklist**.
## Before you answer, check
- Why is clear
- Test steps reproducible
- Risks stated
If something important is missing from my inputs, say what you assumed. Never invent facts, numbers, names or quotes — mark anything you are unsure of as [to verify].
## My inputs
Diff summary or commit messages:
{{changes}}
Why the change was made (ticket, problem):
{{why}}