Format
One section per logical change:
## Change N: <Short Title>
Current way: <one sentence — what happens today>.
New way: <one sentence — what happens after this PR>.
### What To Test
- [ ] <Action verb: Create / Open / Submit / Uncheck…>
- [ ] Confirm <observable outcome>.
- [ ] <Edge case setup>
- [ ] Confirm <edge case outcome>.
Rules:
- "Current way / New way" — plain English, user-facing behavior only. No code, no implementation details.
- Test steps start with an action verb. Confirm steps start with "Confirm".
- Cover happy path + key edge cases. Not exhaustive — just the combinations that matter.
- No filler. No "Overview" or "Summary" headers. Jump straight to the changes.
Workflow
Writing a new description
- Read the diff:
gh pr view <number> --json files,commits,body - Identify logical changes (one section per change).
- Write sections in the format above.
- Post:
gh pr edit <number> --body-file -(pipe the body in; inline--bodybreaks on multi-line/special chars).
Updating an existing description
- Fetch current body first:
gh pr view <number> --json body - Preserve all
- [x]checked checkboxes — never uncheck or remove them. - Preserve any content manually added by author/reviewer outside the generated format.
- Merge in new changes — add new
## Change Nsections, append new test steps. - Only replace content you explicitly generated in a prior run.
- Post the merged result back.
Adding Images
To embed a screenshot or before/after image:
- Produce the image — via your browser-automation tool (e.g.
agent-browser screenshoton the running app; check the project's docs for local login sequences), or use an image the user provides. - Pass the absolute path to the
github-image-uploadskill — it returns agithub.com/user-attachmentsURL ready to paste inline (private-repo images stay private).