| name | create-github-pr |
| description | Creates an English GitHub Pull Request using gh CLI by analyzing commits on the current branch compared to the base branch. Generates a structured PR title and body, shows it for user approval, then creates the PR. Use when the user asks to create a PR, open a pull request, push and create PR, or mentions "gh pr", "pull request", or "open PR". |
Create GitHub PR
Workflow
Step 1 — Collect branch context
Run these in parallel:
git rev-parse --abbrev-ref HEAD
gh repo view --json defaultBranchRef -q '.defaultBranchRef.name'
git log origin/<base>..HEAD --oneline
git diff origin/<base>...HEAD --stat
If the current branch equals the base branch, stop and tell the user to switch to a feature branch first.
If gh is not authenticated, stop and instruct the user to run gh auth login.
Step 2 — Analyze commits and generate PR draft
Analyze the commit log and diff stat to draft:
-
Title: Conventional Commits style, max 72 chars, English, imperative mood.
Format: <type>(<scope>): <subject>
Types: feat, fix, refactor, perf, test, docs, chore, ci
-
Body: Structured markdown using the template below.
PR Body Template
## Summary
<!-- 2-4 bullet points describing what changed and why -->
-
## Changes
<!-- List key files/areas changed -->
-
## Test Plan
<!-- How to verify this works -->
- [ ]
## Notes
<!-- Breaking changes, migration steps, or anything reviewers should know. Remove if not applicable. -->
Fill in all sections based on actual commit messages and diff content. Remove the ## Notes section if there is nothing breaking or noteworthy.
Step 3 — Show draft for approval
Present the full PR draft to the user before creating anything:
────────────────────────────────────────
PULL REQUEST DRAFT
Branch: <current-branch> → <base-branch>
────────────────────────────────────────
Title:
<generated title>
Body:
<generated body>
────────────────────────────────────────
Create this PR? (yes / edit / cancel)
────────────────────────────────────────
Wait for the user to respond:
- yes / confirm / create → proceed to Step 4
- edit / change → apply the user's edits and show the draft again
- cancel / no → abort and inform the user
Step 4 — Push branch and create PR
git push -u origin HEAD
gh pr create \
--title "<title>" \
--body "$(cat <<'EOF'
<body>
EOF
)" \
--base <base-branch>
After creation, output the PR URL returned by gh pr create.
Rules
- Always write in English — title, body, labels, everything.
- Never skip approval — always show the draft and wait for confirmation.
- Never force-push — use
git push -u origin HEAD only.
- Never create a PR from the default branch — validate and stop early if needed.
- If commits include
BREAKING CHANGE: in footers, add a ⚠️ Breaking change note at the top of the body.
- If the branch has no commits ahead of base, stop and tell the user there is nothing to PR.
Examples
Title examples
| Commits | Generated title |
|---|
| feat: add JWT refresh, fix: token expiry | feat(auth): add JWT refresh token with expiry fix |
| chore: upgrade EF Core to 9.0.4 | chore(deps): upgrade EF Core to 9.0.4 |
| fix null ref in transition pipeline | fix(pipeline): prevent null reference in transition handler |
Minimal body example
## Summary
- Add JWT refresh token endpoint to extend session lifetime
- Fix token expiry calculation that caused premature logouts
## Changes
- `src/BBT.Workflow.Application/Auth/TokenService.cs`
- `src/BBT.Workflow.Domain/Auth/RefreshToken.cs`
## Test Plan
- [ ] Log in and wait for access token to expire
- [ ] Verify refresh endpoint returns a new token without re-login
