Skip to content

Commit e26d709

Browse files
authored
feat(pr-ready): Add What Changed section (#1336)
1 parent 6c04ed8 commit e26d709

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

‎.claude/skills/pr-ready/SKILL.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: pr-ready
3-
description: "Use when writing or updating a PR body. Produces Summary (visual), Evidence (before/after), and Merge Danger (door + blast radius) sections."
3+
description: "Use when writing or updating a PR body. Produces What Changed (bullet summary), Summary (visual), Evidence (before/after), and Merge Danger (door + blast radius) sections."
44
metadata:
55
credits:
66
skill: show-me
@@ -12,6 +12,10 @@ metadata:
1212
Use this template for writing the PR body:
1313

1414
```markdown
15+
## What Changed
16+
17+
- <3-5 bullets, one change each>
18+
1519
## Summary
1620

1721
<diagram, diff-sketch, or tree>
@@ -36,6 +40,10 @@ Use this template for writing the PR body:
3640

3741
Skip all preambles and keep prose brief. Use the user's domain language from `GLOSSARY.md`.
3842

43+
### What Changed
44+
45+
The 30-second read for a reviewer. 3-5 bullets, one change per bullet, most important first. Name the concrete thing (field, function, default, dependency), not the file. Show old → new values inline (`threshold 0.9 → 0.5`). Call out removed or renamed fields in **bold**. End with one headline number if there is evidence (e.g. `F1 0.74 → 0.85`). No rationale paragraphs; that goes in Summary or Merge Danger.
46+
3947
### Summary
4048

4149
Pick the smallest view that makes the key point clear.

‎.github/workflows/pr-ready.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
6363
const prompt = `You are rewriting the body of a GitHub pull request.
6464
65-
Follow the skill below exactly. Keep the repository PR template's sections (## Issue, ## Checklist, ## Notes) and fill them from the current body; replace the template's ## Summary with the skill's three sections (## Summary, ## Evidence, ## Merge Danger) in that order, between ## Issue and ## Checklist. Keep any "Closes ..." issue reference verbatim; if none, write "Closes #PLEASE_TYPE_ISSUE_NUMBER". Preserve checklist [x]/[ ] states from the current body. Do not invent evidence: only cite tests, numbers or screenshots present in the current body or diff. Output ONLY the markdown body.
65+
Follow the skill below exactly. Keep the repository PR template's sections (## Issue, ## Checklist, ## Notes) and fill them from the current body; replace the template's ## Summary with the skill's four sections (## What Changed, ## Summary, ## Evidence, ## Merge Danger) in that order, between ## Issue and ## Checklist. Keep any "Closes ..." issue reference verbatim; if none, write "Closes #PLEASE_TYPE_ISSUE_NUMBER". Preserve checklist [x]/[ ] states from the current body. Do not invent evidence: only cite tests, numbers or screenshots present in the current body or diff. Output ONLY the markdown body.
6666
6767
<skill>
6868
${skill}

0 commit comments

Comments
 (0)