PR description
pr-description · v1.1.0
ivyx
How to write a pull request description a reviewer can act on from the branch's commits and diff.
Who is asked
Risk low: it loads without asking anyone. Each tool it then calls still meets your policy.
Tools it may call
It names no tools, so the run keeps the tools it had.
What it tells the agent
The published SKILL.md, as written.
--- name: pr-description description: How to write a pull request description a reviewer can act on from the branch's commits and diff. metadata: risk: low ---
Writing a pull request description
A reviewer reads the description before the diff. It should tell them why the change exists, what it does, how to check it, and where to look hard.
1. Read the branch
source-control.graphwithscope: currentshows the branch's commits; the ones above the point where it left the main branch are this change. If you cannot tell where that is, ask.- Read the combined change:
source-control.difffor each commit (source: commit), orsource: worktreeif the work is not committed.
2. Fill the template
Read template.md (call this skill with { "file": "template.md" }) and fill it.
- Why: the problem, in one or two sentences, from the user's or the system's side. Not "this PR adds X".
- What: the change in a few bullets, the important one first. Name a file only when the reviewer needs to go there.
- How to check: the steps or the command that shows it working, and what they should see.
- Look closely at: the one or two places where a mistake would hurt, and why.
- Not in this change: what a reviewer might expect and will not find.
Keep it short. A description longer than the diff is a sign the change should be split; say that instead.
3. Hand it over
Show the description. Do not open or edit a pull request yourself.
Files it reads
Loading the skill lists these to the agent. It reads one when the instructions send it there.
template.md
## Why ## What - ## How to check ## Look closely at ## Not in this change