name: git-pr
description: Guide for creating effective Pull Requests. Use when opening PRs, writing PR descriptions, requesting reviews, or managing PR workflow.

Git Pull Requests

This skill provides guidance for creating clear, reviewable Pull Requests that facilitate efficient code review.

When to Use This Skill

• Opening a new Pull Request
• Writing PR titles and descriptions
• Choosing merge strategy
• Managing PR workflow

Branch Naming

Naming Rules:
- Lowercase with hyphens
- Include ticket number if available: feature/JIRA-123-user-auth
- Keep short but descriptive

PR Title

Follow the same format as commit messages:

<type>(<scope>): <description>

Examples:

feat(auth): add OAuth2 login support
fix(cart): resolve duplicate item bug
docs: update API documentation

PR Description Template

## Summary
Brief description of what this PR does.

## Changes
- Change 1
- Change 2
- Change 3

## Type of Change
- [ ] Bug fix (non-breaking change fixing an issue)
- [ ] New feature (non-breaking change adding functionality)
- [ ] Breaking change (fix or feature causing existing functionality to change)
- [ ] Documentation update

## Testing
- [ ] Unit tests pass
- [ ] Integration tests pass
- [ ] Manual testing completed

## Screenshots (if applicable)
[Add screenshots here]

## Related Issues
Closes #123

PR Size Guidelines

[!TIP]
Smaller PRs get reviewed faster and have fewer bugs. Aim for < 400 lines.

Draft vs Ready

# Create as draft
gh pr create --draft

# Mark ready for review
gh pr ready

Requesting Reviews

Choose reviewers who:
- Own the code area being changed
- Have context on the feature/issue
- Are available (check workload)

Minimum reviewers:
- Small changes: 1 reviewer
- Medium changes: 2 reviewers
- Large/critical changes: 2-3 reviewers

Merge Strategies

Recommendations:
- Default: Squash and merge for feature branches
- Use Rebase for clean, well-organized commits
- Use Merge commit when history matters

Resolving Conflicts

# Update your branch with target
git fetch origin
git rebase origin/main
# OR
git merge origin/main

# Resolve conflicts in files
# Then continue
git rebase --continue
# OR
git merge --continue

# Force push (if rebased)
git push --force-with-lease

Decision Tree

PR Workflow
├── Create branch
│   └── Use naming convention: feature/, fix/, etc.
├── Make changes
│   └── Commit using Conventional Commits
├── Open PR
│   ├── Work in progress → Create as Draft
│   └── Ready for review → Create as Ready
├── Get reviews
│   ├── Changes requested → Address feedback, re-request
│   └── Approved → Proceed to merge
└── Merge
    ├── Many small commits → Squash and merge
    ├── Clean commit history → Rebase and merge
    └── Need full history → Merge commit

Common Mistakes

GitHub CLI Commands

# Create PR
gh pr create --title "feat: add feature" --body "Description"

# Create draft PR
gh pr create --draft

# View PR status
gh pr status

# Request review
gh pr edit --add-reviewer username

# Merge PR
gh pr merge --squash

# Close PR
gh pr close

Resources

• PR Template - Copy to .github/PULL_REQUEST_TEMPLATE.md in your repo

Related Skills

• Git Commit - Writing commit messages
• Git Review - Reviewing PRs