git-pr

GitHub Pull Request Conventions

PR Title Format

type: Short description of the change

• Use the same type conventions as git-commit (feat, fix, docs, etc.).
• Sentence case for the description (capital first letter, no trailing period).
• Keep it concise (under 70 characters is ideal).
• The description should summarize the intent of the whole PR, not list individual commits.

Title examples

feat: Add retry policy to HTTP client
fix: Handle null input in prompt builder
docs: Add platform comparison document
chore: Update skill frontmatter spec

---

PR Body Structure

Use this template when writing the PR description. Adjust sections as needed for the size and complexity of the change — small fixes may only need the summary.

## Summary

<1–3 bullet points explaining what changed and why>

## Changes

<Grouped list of notable changes.>

## Test plan

<How was this tested? What should reviewers verify?>

Body guidelines

• Lead with the why. Reviewers already have the diff — tell them what problem this solves.
• Keep it scannable. Bullet points and short paragraphs. No walls of text.
• Mention risks. If the change has migration steps or deployment ordering constraints, call them out.

---

Workflow

Creating a new PR

1. Ensure the branch is pushed with tracking set:

   git push -u origin HEAD
   

2. Create the PR using gh pr create. Pass the body via a HEREDOC to preserve formatting. Keep HEREDOC content flush-left so GitHub renders the markdown correctly:

   gh pr create --title "type: Description here" --body "$(cat <<'EOF'
   ## Summary
   
   - <what changed and why>
   
   ## Changes
   
   - <notable change 1>
   - <notable change 2>
   
   ## Test plan
   
   - [ ] <verification step>
   EOF
   )"
   

   Use --base <branch> if targeting a branch other than the repository default.

3. Return the PR URL to the user so they can review it.