github-pr

GitHub PR Creation

Create well-structured pull requests using gh pr create with consistent formatting and conventions.

Prerequisites

1. gh CLI is installed and authenticated
2. Current directory is a git repository
3. Changes are committed and on a feature branch (not main or master)

Workflow

1. Check prerequisites

# Determine branches
current_branch=$(git branch --show-current)
base_branch=${BASE_BRANCH:-$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')}

printf 'current=%s base=%s\n' "$current_branch" "$base_branch"

If the current branch matches the default/base branch, stop before pushing and ask the user to create a feature branch first.

Once on a feature branch, ensure it is pushed to remote:

git push -u origin HEAD

2. Determine PR type

Infer the type from the branch name prefix:

Prefix	Type	Label
feat/, feature/	Feature	enhancement
fix/, bugfix/	Bugfix	bug
hotfix/	Hotfix	bug, priority: critical
chore/, refactor/, docs/, test/	Chore	chore

If the branch name doesn't match a known prefix, ask the user what type of PR this is.

3. Generate PR title

Convert the branch name to a conventional commit-style title:

• feat/add-user-auth → feat: add user auth
• fix/login-crash → fix: login crash
• hotfix/null-pointer → fix: null pointer

Replace hyphens with spaces. Drop the prefix category from the branch name. Capitalise only where appropriate.

If the branch has a single commit, prefer the commit message as the title instead.

4. Fill the PR body

Read the matching template from assets/ and fill it in based on the changes:

• Feature → assets/feature.md
• Bugfix → assets/bugfix.md
• Hotfix → assets/hotfix.md
• Chore → use the feature template

To understand what changed, run:

# See commits on this branch
base_branch=${BASE_BRANCH:-$(gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name')}
git log --oneline "$base_branch"..HEAD

# See the full diff
git diff "$base_branch"...HEAD --stat
git diff "$base_branch"...HEAD