ghpr

Create Pull Request

Create a pull request with auto-generated title and body from commits.

Arguments: $ARGUMENTS (optional base branch, defaults to main)

Instructions

1. Parse the base branch:

   • If $ARGUMENTS is provided, use it as the base branch
   • Otherwise, default to main

2. Gather information about the current branch:

   • Run git branch --show-current to get the current branch name
   • Run git log <base>..HEAD --oneline to see commits not in base
   • Run git diff <base>...HEAD --stat to see changed files summary

3. Analyze the commits to generate:

   • Title: A clear, descriptive summary of what the PR does
   • Body: A 2-3 sentence summary explaining the key changes and why they were made

4. Check if branch needs to be pushed:

   • Run git status to check if ahead of remote
   • Push with git push -u origin <branch> if needed

5. Create the PR using:

gh pr create --base <base-branch> --title "the pr title" --body "$(cat <<'EOF'
## Summary
<2-3 sentence summary explaining what changed and why>

## Why

- <reason 1>
  - <detail or example for reason 1>
- <reason 2>
  - <detail or example for reason 2>
- ...

## Before and After (if applicable)

| Before | After |
|--------|-------|
| <screenshot or description> | <screenshot or description> |
| <screenshot or description> | <screenshot or description> |
....

## Commit History
- <commit message 1> (<commit link 1>) : <commit description>
- <commit message 2> : <commit description or link>
...

## Test Plan
- [ ] <plan for testing the changes, e.g., "Run unit tests", "Test manually on staging", etc.>
- [ ] <additional test steps>
- [ ] ...


---
Assisted-By: <agenting tool name>(<model name>)
EOF
)"

The Assisted-By footer credits the AI agent that assisted in creating the PR. Use the actual tool name and model you are running as (e.g., Assisted-By: Claude Code(claude-opus-4-6)).

6. Return the PR URL to the user.

Examples

• /ghpr - Create PR against main
• /ghpr develop - Create PR against develop branch

Important

• Compare against the specified base branch (default: main)
• If there is upstream remote repository, please ensure that Pull Requests target is the upstream repository, not the forked repository
• If there are no commits ahead of base, inform the user
• Don't push to the base branch directly - warn if on base branch