pr-creator
Write PR descriptions like a developer posting in Slack, not an AI summarizing a diff.
- IS: creating or updating a GitHub PR's title, body, draft state, and reviewers, plus the commit restructuring and review path that make a large diff readable.
- IS NOT: changing the code in the diff (use
tidy), reviewing it for bugs (use pr-reviewer), watching CI and review comments after the PR exists (use pr-babysitter), or cutting npm releases (use autoship).
Reference Files
| File |
Read When |
references/pr-polish.md |
Commits contain fixup, WIP, or "address review" noise, the diff exceeds 500 lines, or the user asks to polish, restructure, squash, or split the PR |
Workflow
Copy this checklist to track progress:
PR creation progress:
- [ ] Inspect the current branch and diff against the existing PR base, or the discovered default branch merge-base
- [ ] Existing PR? gh pr view --json url,state,isDraft (state OPEN means edit, not create)
- [ ] Linear ID from branch, commits, prompt, or issue link; no ID means no prefix
- [ ] Noisy commits or a >500-line diff? references/pr-polish.md, before pushing
- [ ] PR template present? Read it (paths under Templates)
- [ ] Draft title and body against Rules and Anti-patterns
- [ ] git push -u origin HEAD
- [ ] gh pr create (or gh pr edit); then gh pr view --json url,title and return the URL
Do not ask the user to approve the description first; the point is speed. They can ask for a rewrite and you run gh pr edit.
Rules
- Title. With a Linear ID:
ABC-123: Add auth flow. Without one: Add auth flow. Under 60 characters, no trailing period. If the repo lints PR titles (a semantic-pull-request or commitlint workflow under .github/workflows/), use its shape and put the ID at the end: feat: add auth flow (ABC-123). Linear links on the ID wherever it sits in the title.
- Body. One short paragraph: what changed and why it matters. Length follows the change; a one-line body is fine for a one-line fix.
- No fake why. If the reason is not in the prompt, the Linear issue, the branch, the commits, or the diff, leave it out rather than inventing one.
- Risk only when real. One
Risk: line for migrations, billing, auth, permissions, irreversible writes, wide blast radius, or a subtle behavior change. Otherwise nothing.
- Testing only if real. Say what you ran only if you ran it. Never a
Test plan section, never checkboxes.
- Partial work. If this PR does not finish the Linear issue, keep the ID out of the title and write
Part of ABC-123 in the body. Linear's default automation moves a linked issue to Done when the PR merges; the non-closing magic word links without closing.
- Draft and reviewers only when asked.
--draft for "draft" or "WIP"; gh pr ready promotes it later, gh pr ready --undo demotes. --reviewer alice,org/team only for people the user named; CODEOWNERS already requests owners.
- Stop after the useful content. The harness's
attribution setting owns the PR footer (Generated with Claude Code, session link). Never hand-write one, and never strip one the harness or a repo policy appends. Everything above the footer is this skill's; its one-paragraph body replaces the harness's default Summary and Test plan sections.
Anti-patterns: never write these
- Openers that narrate the artifact: "This PR implements...", "This change ensures...", "This commit introduces..."
- Changelog verbs with no reason attached: "Refactored X to improve Y", "Updated Z to handle...", "Added comprehensive test coverage for..."
- Lines that start with a filename or path; the diff already lists the files
- A
Test plan section with checkboxes
- A bullet list that restates the diff
Examples
Feature (ABC-123 is the real Linear ID)
Title: ABC-123: Add auth flow with session management
Adds the auth flow needed for session-based login, including refresh, timeout handling, and a small error boundary for auth failures.
Bugfix (real risk, real testing)
Title: PAY-482: Dedupe Stripe webhook retries
Stripe retries webhooks on timeout and our handler wasn't idempotent, so retried events created duplicate invoices. Now we record processed event IDs and skip repeats. Tested by replaying a captured retry sequence locally.
Risk: touches the billing write path.
Chore (no Linear ID, no why beyond the diff)
Title: Bump eslint to 9 and fix the new no-unused-vars hits
Bumps eslint to 9. The only code change is removing three unused imports it now flags.
The first two carry the real why from the commits and stop. Risk: earns its line in the second because the diff touches billing writes; the testing sentence is there only because a replay actually ran. The third has no deeper why, so it does not pretend to.
Templates
GitHub reads the first match of pull_request_template.md (case-insensitive) in .github/, the repo root, or docs/, or a PULL_REQUEST_TEMPLATE/ directory in any of those for multiple templates. gh pr create --body skips the template entirely, so when one exists, read it and write the body in its shape: keep its headings, answer each in a sentence or two, and put the one-paragraph description under the first heading. Add nothing the template does not ask for.
Creating the PR
Write the exact body to a temporary file with the file tool, then pass its path through --body-file. The examples use /tmp/pr-body.md; choose a task-specific temporary path during execution.
No PR yet: create
git push -u origin HEAD # when creating a PR for local commits
gh pr create --title "ABC-123: Add auth flow" --body-file /tmp/pr-body.md
gh pr view --json url,title # evidence the PR exists; return the url
Add --draft or --reviewer here when Rule 7 applies. --base only when the target is not the default branch.
PR already open: update title and body
gh pr edit overwrites the title and body wholesale, so draft the full replacement, not a patch. Same rules and anti-patterns apply.
# A metadata-only edit does not push local commits.
gh pr edit --title "ABC-123: Add auth flow" --body-file /tmp/pr-body.md
gh pr view --json url,title # confirm the update; return the url
Gotchas
gh pr create on a branch with no upstream: in a TTY it blocks on a "Where should we push?" prompt; from a non-interactive harness it aborts with you must first push the current branch to a remote, or use the --head flag. Either way, git push -u origin HEAD first.
- Non-interactive
gh pr create needs both --title and --body (or --fill); without them it exits with must provide --title and --body (or --fill) when not running interactively. --fill copies commit messages verbatim, which is exactly the changelog body this skill exists to avoid.
- Quote the heredoc delimiter (
<<'EOF'). Unquoted <<EOF lets the shell expand backticks and $vars in the body, corrupting the description or running commands.
- Two different failures look alike: on the default branch,
gh pr create aborts with must be on a branch named differently than "main"; on a branch with nothing new against the base it fails with No commits between main and <branch>. The first needs a branch, the second a commit.
- A branch with an open PR fails
gh pr create with a pull request for branch ... into branch main already exists. gh pr view --json state first; OPEN means gh pr edit. A MERGED or CLOSED result is a stale PR, so create a new one.
- Derive the Linear ID from the branch, uppercased: Linear's default branch format is
username/abc-123-title-slug, so mblode/abc-123-add-auth gives ABC-123. Never guess an ID: Linear links the PR to whatever ID the title contains, and a wrong one moves someone else's issue.
- Plain
git diff omits committed changes. Use the actual PR base with three-dot diff; do not assume main, especially for stacked PRs.
- Restructure commits before the first push. Force-pushing a rewritten branch under an open PR marks existing inline comments "outdated" and the reviewer loses their thread.
Related skills
pr-reviewer: run before creating to check the diff for bugs.
tidy: applies fixes to the code in the diff; this skill edits only the PR and its commits.
pr-babysitter: hand off after creation to watch CI, conflicts, and review comments.
autoship: npm release pipeline (changesets, version PR, publish); "ship it" without release context routes here instead.
Maintenance only: evals/evals.json contains regression scenarios for changes to this skill; it does not load during a user task.
1---2name: pr-creator3description: Creates or updates GitHub PRs with house-style titles and bodies, issue linking, repository templates, and draft state. Use when asked to "create a PR", "rewrite the PR description", or "polish this PR". For code fixes use tidy; for CI and review threads use pr-babysitter; for npm releases use autoship.4---5
6# pr-creator
7
8Write PR descriptions like a developer posting in Slack, not an AI summarizing a diff.
9
10- **IS:** creating or updating a GitHub PR's title, body, draft state, and reviewers, plus the commit restructuring and review path that make a large diff readable.
11- **IS NOT:** changing the code in the diff (use `tidy`), reviewing it for bugs (use `pr-reviewer`), watching CI and review comments after the PR exists (use `pr-babysitter`), or cutting npm releases (use `autoship`).
12
13## Reference Files
14
15| File | Read When |
16|------|-----------|
17| `references/pr-polish.md` | Commits contain fixup, WIP, or "address review" noise, the diff exceeds 500 lines, or the user asks to polish, restructure, squash, or split the PR |
18
19## Workflow
20
21Copy this checklist to track progress:
22
23```text
24PR creation progress:
25- [ ] Inspect the current branch and diff against the existing PR base, or the discovered default branch merge-base
26- [ ] Existing PR? gh pr view --json url,state,isDraft (state OPEN means edit, not create)
27- [ ] Linear ID from branch, commits, prompt, or issue link; no ID means no prefix
28- [ ] Noisy commits or a >500-line diff? references/pr-polish.md, before pushing
29- [ ] PR template present? Read it (paths under Templates)
30- [ ] Draft title and body against Rules and Anti-patterns
31- [ ] git push -u origin HEAD
32- [ ] gh pr create (or gh pr edit); then gh pr view --json url,title and return the URL
33```
34
35Do not ask the user to approve the description first; the point is speed. They can ask for a rewrite and you run `gh pr edit`.
36
37## Rules
38
391. **Title.** With a Linear ID: `ABC-123: Add auth flow`. Without one: `Add auth flow`. Under 60 characters, no trailing period. If the repo lints PR titles (a `semantic-pull-request` or commitlint workflow under `.github/workflows/`), use its shape and put the ID at the end: `feat: add auth flow (ABC-123)`. Linear links on the ID wherever it sits in the title.
402. **Body.** One short paragraph: what changed and why it matters. Length follows the change; a one-line body is fine for a one-line fix.
413. **No fake why.** If the reason is not in the prompt, the Linear issue, the branch, the commits, or the diff, leave it out rather than inventing one.
424. **Risk only when real.** One `Risk:` line for migrations, billing, auth, permissions, irreversible writes, wide blast radius, or a subtle behavior change. Otherwise nothing.
435. **Testing only if real.** Say what you ran only if you ran it. Never a `Test plan` section, never checkboxes.
446. **Partial work.** If this PR does not finish the Linear issue, keep the ID out of the title and write `Part of ABC-123` in the body. Linear's default automation moves a linked issue to Done when the PR merges; the non-closing magic word links without closing.
457. **Draft and reviewers only when asked.** `--draft` for "draft" or "WIP"; `gh pr ready` promotes it later, `gh pr ready --undo` demotes. `--reviewer alice,org/team` only for people the user named; CODEOWNERS already requests owners.
468. **Stop after the useful content.** The harness's `attribution` setting owns the PR footer (`Generated with Claude Code`, session link). Never hand-write one, and never strip one the harness or a repo policy appends. Everything above the footer is this skill's; its one-paragraph body replaces the harness's default `Summary` and `Test plan` sections.
47
48## Anti-patterns: never write these
49
50- Openers that narrate the artifact: "This PR implements...", "This change ensures...", "This commit introduces..."
51- Changelog verbs with no reason attached: "Refactored X to improve Y", "Updated Z to handle...", "Added comprehensive test coverage for..."
52- Lines that start with a filename or path; the diff already lists the files
53- A `Test plan` section with checkboxes
54- A bullet list that restates the diff
55
56## Examples
57
58### Feature (`ABC-123` is the real Linear ID)
59
60```text
61Title: ABC-123: Add auth flow with session management
62
63Adds the auth flow needed for session-based login, including refresh, timeout handling, and a small error boundary for auth failures.
64```
65
66### Bugfix (real risk, real testing)
67
68```text
69Title: PAY-482: Dedupe Stripe webhook retries
70
71Stripe retries webhooks on timeout and our handler wasn't idempotent, so retried events created duplicate invoices. Now we record processed event IDs and skip repeats. Tested by replaying a captured retry sequence locally.
72
73Risk: touches the billing write path.
74```
75
76### Chore (no Linear ID, no why beyond the diff)
77
78```text
79Title: Bump eslint to 9 and fix the new no-unused-vars hits
80
81Bumps eslint to 9. The only code change is removing three unused imports it now flags.
82```
83
84The first two carry the real why from the commits and stop. `Risk:` earns its line in the second because the diff touches billing writes; the testing sentence is there only because a replay actually ran. The third has no deeper why, so it does not pretend to.
85
86## Templates
87
88GitHub reads the first match of `pull_request_template.md` (case-insensitive) in `.github/`, the repo root, or `docs/`, or a `PULL_REQUEST_TEMPLATE/` directory in any of those for multiple templates. `gh pr create --body` skips the template entirely, so when one exists, read it and write the body in its shape: keep its headings, answer each in a sentence or two, and put the one-paragraph description under the first heading. Add nothing the template does not ask for.
89
90## Creating the PR
91
92Write the exact body to a temporary file with the file tool, then pass its path through `--body-file`. The examples use `/tmp/pr-body.md`; choose a task-specific temporary path during execution.
93
94### No PR yet: create
95
96```bash
97git push -u origin HEAD # when creating a PR for local commits
98
99gh pr create --title "ABC-123: Add auth flow" --body-file /tmp/pr-body.md
100
101gh pr view --json url,title # evidence the PR exists; return the url
102```
103
104Add `--draft` or `--reviewer` here when Rule 7 applies. `--base` only when the target is not the default branch.
105
106### PR already open: update title and body
107
108`gh pr edit` overwrites the title and body wholesale, so draft the full replacement, not a patch. Same rules and anti-patterns apply.
109
110```bash
111# A metadata-only edit does not push local commits.
112
113gh pr edit --title "ABC-123: Add auth flow" --body-file /tmp/pr-body.md
114
115gh pr view --json url,title # confirm the update; return the url
116```
117
118## Gotchas
119
120- `gh pr create` on a branch with no upstream: in a TTY it blocks on a "Where should we push?" prompt; from a non-interactive harness it aborts with `you must first push the current branch to a remote, or use the --head flag`. Either way, `git push -u origin HEAD` first.
121- Non-interactive `gh pr create` needs both `--title` and `--body` (or `--fill`); without them it exits with `must provide --title and --body (or --fill) when not running interactively`. `--fill` copies commit messages verbatim, which is exactly the changelog body this skill exists to avoid.
122- Quote the heredoc delimiter (`<<'EOF'`). Unquoted `<<EOF` lets the shell expand backticks and `$vars` in the body, corrupting the description or running commands.
123- Two different failures look alike: on the default branch, `gh pr create` aborts with `must be on a branch named differently than "main"`; on a branch with nothing new against the base it fails with `No commits between main and <branch>`. The first needs a branch, the second a commit.
124- A branch with an open PR fails `gh pr create` with `a pull request for branch ... into branch main already exists`. `gh pr view --json state` first; `OPEN` means `gh pr edit`. A `MERGED` or `CLOSED` result is a stale PR, so create a new one.
125- Derive the Linear ID from the branch, uppercased: Linear's default branch format is `username/abc-123-title-slug`, so `mblode/abc-123-add-auth` gives `ABC-123`. Never guess an ID: Linear links the PR to whatever ID the title contains, and a wrong one moves someone else's issue.
126- Plain `git diff` omits committed changes. Use the actual PR base with three-dot diff; do not assume `main`, especially for stacked PRs.
127- Restructure commits before the first push. Force-pushing a rewritten branch under an open PR marks existing inline comments "outdated" and the reviewer loses their thread.
128
129## Related skills
130
131- `pr-reviewer`: run before creating to check the diff for bugs.
132- `tidy`: applies fixes to the code in the diff; this skill edits only the PR and its commits.
133- `pr-babysitter`: hand off after creation to watch CI, conflicts, and review comments.
134- `autoship`: npm release pipeline (changesets, version PR, publish); "ship it" without release context routes here instead.
135
136Maintenance only: `evals/evals.json` contains regression scenarios for changes to this skill; it does not load during a user task.