Skip to main content
skill CX Codex

github-pr — Claude Code skill: what it does, how to install

github-pr guides AI agents to format pull requests using Conventional Commits and GitHub CLI commands.

MIT 205 installs ★ 678 updated 2026-03-28

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add Gentleman-Programming/Gentleman-Skills --skill github-pr -a claude-code
Open on GitHub

What github-pr does

This skill enforces a consistent workflow for GitHub Pull Requests. It establishes title formatting based on conventional types like feat, fix, refactor, and chore, while pushing developers toward atomic commits rather than massive single-commit dumps.

Generated descriptions follow a structured layout containing a brief summary, an explicit list of modifications, testing checkboxes, and issue closing keywords. For multiline entries, it provides heredoc shell syntax.

Execution requires the gh CLI utility configured in your environment, because all actions depend directly on GitHub CLI subcommands.

What it helps with

  • structure pull request titles following conventional commit types
  • generate markdown PR bodies with testing checklists and linked issues
  • build gh pr create commands with labels and assigned reviewers
  • split bulky diffs into atomic commits before code review

Example prompts for the agent

  • Create a pull request for this branch using gh pr create with testing notes
  • Open a draft PR for the auth refactor linking issue #123
  • Prepare atomic commit messages for the changes in user service

How to install github-pr

1Skills CLI (Vercel)

npx skills add Gentleman-Programming/Gentleman-Skills --skill github-pr -a claude-code

2Manually: put the files in place

~/.claude/skills/github-pr/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/github-pr/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about github-pr

How to install github-pr in Claude Code?

Run npx skills add Gentleman-Programming/Gentleman-Skills --skill github-pr -a claude-code. The file will be placed into ~/.claude/skills/github-pr/SKILL.md.

What does github-pr do?

It provides strict guidelines for drafting PR titles, structuring body summaries, and executing gh CLI commands cleanly.

Does this skill require GitHub CLI?

Yes, it relies directly on the gh binary to open PRs, assign reviewers, inspect diffs, and handle squashes.

Source text

SKILL.md · MIT
---
name: github-pr
description: >
  Create high-quality Pull Requests with conventional commits and proper descriptions.
  Trigger: When creating PRs, writing PR descriptions, or using gh CLI for pull requests.
metadata:
  author: gentleman-programming
  version: "1.0"
---

## When to Use

- Creating a new Pull Request
- Writing PR titles and descriptions
- Preparing commits for review
- Using `gh pr create` command

---

## Critical Patterns

### PR Title = Conventional Commit

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

feat     New feature
fix      Bug fix  
docs     Documentation
refactor Code refactoring
test     Adding tests
chore    Maintenance
```

### PR Description Structure

```markdown
## Summary
- 1-3 bullet points explaining WHAT and WHY

## Changes
- List main changes

## Testing
- [ ] Tests added/updated
- [ ] Manual testing done

Closes #123
```

### Atomic Commits

```bash
# Good: One thing per commit
git commit -m "feat(user): add User model"
git commit -m "feat(user): add UserService"
git commit -m "test(user): add UserService tests"

# Bad: Everything in one commit
git commit -m "add user feature"
```

---

## Code Examples

### Basic PR Creation

```bash
gh pr create \
  --title "feat(auth): add OAuth2 login" \
  --body "## Summary
- Add Google OAuth2 authentication

## Changes
- Added AuthProvider component
- Created useAuth hook

Closes #42"
```

### PR with HEREDOC (Complex Description)

```bash
gh pr create --title "feat(dashboard): add analytics" --body "$(cat <<'EOF'
## Summary
- Add real-time analytics dashboard

## Changes
- Created AnalyticsProvider
- Added LineChart, BarChart components

## Testing
- [x] Unit tests for components
- [x] Manual testing complete

## Screenshots
![Dashboard](url)

Closes #123
EOF
)"
```

### Draft PR

```bash
gh pr create --draft \
  --title "wip: refactor auth" \
  --body "Work in progress"
```

### PR with Reviewers and Labels

```bash
gh pr create \
  --title "feat(api): add rate limiting" \
  --body "Adds rate limiting to API" \
  --reviewer "user1,user2" \
  --label "enhancement,api"
```

---

## Commands

```bash
# Create PR
gh pr create --title "type(scope): desc" --body "..."

# Create with web editor
gh pr create --web

# View PR status
gh pr status

# View diff
gh pr diff

# Check CI status
gh pr checks

# Merge with squash
gh pr merge --squash

# Add reviewer
gh pr edit --add-reviewer username
```

---

## Anti-Patterns

### Don't: Vague Titles

```bash
# Bad
gh pr create --title "fix bug"
gh pr create --title "update"

# Good
gh pr create --title "fix(auth): prevent session timeout"
```

### Don't: Giant PRs

```bash
# Bad: 50 files, 2000+ lines in one PR

# Good: Split into logical PRs
# PR 1: feat(models): add User model
# PR 2: feat(api): add user endpoints
# PR 3: feat(ui): add user pages
```

### Don't: Empty Descriptions

```bash
# Bad
--body "Added feature"

# Good
--body "## Summary
- What you did and why

## Changes  
- Specific changes

Closes #123"
```

---

## Quick Reference

| Task | Command |
|------|---------|
| Create PR | `gh pr create -t "type: desc" -b "body"` |
| Draft PR | `gh pr create --draft` |
| Web editor | `gh pr create --web` |
| Add reviewer | `--reviewer user1,user2` |
| Add label | `--label bug,high-priority` |
| Link issue | `Closes #123` in body |
| View status | `gh pr status` |
| Merge squash | `gh pr merge --squash` |

## Resources

- [Conventional Commits](https://www.conventionalcommits.org/)
- [GitHub CLI Manual](https://cli.github.com/manual/gh_pr_create)

© gentleman-programming · MIT · Gentleman-Programming/Gentleman-Skills

Similar skills

All skills for Git and GitHub →

From the same set20

The whole set →
react-native Patterns for React Native mobile development across iOS and Android. Covers typed components, navigation with Expo Router, NativeWind styling, and state management. CX Codex +1 263installs hexagonal-architecture-layers-java The hexagonal-architecture-layers-java skill structures Java services around Domain, Application, and Infrastructure layers. Use it for new services or Spring refactoring. CX Codex +1 250installs angular-core angular-core — a skill that teaches the agent modern Angular patterns: standalone components, signals instead of hooks, zoneless mode, and native control flow. CX Codex +1 230installs jira-task Generates structured Jira tasks following Prowler's format. Handles bug reports, feature requests, and refactoring work with proper titles, acceptance criteria, and component-based splitting. CX Codex +1 217installs playwright Skill for writing E2E tests on Playwright using the Page Objects pattern. Guides you through exploring real UI with MCP tools first, then writing selectors and assertions based on actual page structure. CX Codex +1 194installs elixir-antipatterns elixir-antipatterns is a Claude Code skill that guides code reviews, Ecto query tuning, and Phoenix refactoring with a catalog of 8 anti-patterns. CX Codex +1 194installs nextjs-15 Supplies Next.js 15 App Router patterns covering file conventions, Server Actions, parallel data fetching, and middleware. CX Codex +1 185installs electron Guides desktop app development in Electron with secure IPC patterns, typed channels, and clear separation between main and renderer processes. CX Codex +1 175installs

Project sponsors

Companies that keep this analytics open