PR Description Writer
Create and publish high-quality PR descriptions that help reviewers understand intent, implementation details, and verification steps.
When to Use
- Opening a new PR
- Refreshing a stale or minimal PR description
- Capturing implementation rationale for future debugging
Goals
Every PR body should clearly answer:
- What changed?
- Why did we make this change now?
- How was it implemented?
- How was it tested?
- What risks or follow-ups remain?
Workflow
- Discover PR context and changed files.
- Extract intent from commit(s) and code changes.
- Draft a structured PR body.
- Apply the body to the PR.
- Re-open the PR view and confirm body/labels.
Commands
# Identify the active PR for current branch
gh pr view --json number,title,url,baseRefName,headRefName
# Inspect changed files and patch summary
gh pr diff --name-only
gh pr diff
# Review commit messages for intent
git log --oneline --decorate -n 10
# Apply updated body
gh pr edit <pr-number> --body-file /tmp/pr-body.md
Body Structure
Use the template in references/pr-body-template.md.
Required sections:
## Why## What Changed## Implementation Details## Testing## Risks / Follow-ups
Quality Bar
- Be specific: name concrete files, routes, scripts, and commands.
- Explain tradeoffs and constraints, not just mechanics.
- Testing section must include exact commands run and outcomes.
- If something is not tested, state it explicitly.
Optional Enhancements
- Add
## Screenshotsfor UI work. - Add
## Rollout Noteswhen release sequencing matters. - Add
## Reviewer Guidefor large diffs.