smart-pr

Files (1)

• SKILL.md

SKILL.md (first lines)

# Smart PR Generator

This skill automatically generates or updates Pull Request titles and descriptions based on branch diffs. It analyzes code changes and uses AI to create meaningful, well-structured PR content.

## Prerequisites

- **GitHub CLI**: Must be authenticated via `gh auth login`
- **Git Repository**: Must be in a git repository
- **Not on Main Branch**: Must be on a feature/bug/task branch (not main/master)

## Usage

When invoked, this skill will:
1. Verify you're on a feature branch (not main/master)
2. Check if a PR already exists for the current branch
3. Analyze all changes between your branch and the base branch
4. Generate a PR title following conventional commit format
5. Generate a structured PR description with summary, changes, and testing checklist
6. Determine the appropriate PR label based on change type
7. Create a new PR or update the existing PR with generated content and label

## How it Works

### Step 1: Verify Git Context
- Check current branch: `git branch --show-current`
- Ensure not on main/master/develop branch (error if on base branch)
- Determine base branch (try main, then master, then develop)

### Step 2: Check for Existing PR
- Check if PR exists: `gh pr view --json number,title,body`
- Capture PR number if found

### Step 3: Gather Diff Information
- Get changes: `git diff <base>...HEAD` (base is main, master, or develop)
- Get commit history: `git log <base>...HEAD --oneline`
- For diffs over 5000 lines, use `git diff --stat` instead

### Step 4: Analyze Changes
Analyze the diff to understand:
- Which files changed and their purpose
- Nature of changes (feature, fix, refactor, docs, tests)
- Scope (single component vs multiple)
- Commit messages for context

### Step 5: Generate PR Title
**Format**: `<type>: <concise description>`

**Types**:
- `feat`: New feature
- `fix`: Bug fix
- `refactor`: Code refactoring without behavior change
- `docs`: Documentation changes
- `test`: Test additions or modifications
- `chore`: Maintenance tasks (dependencies, configs, etc.)
- `perf`: Performance improvements

**Rules**:
- Maximum 72 characters
- Use imperative mood ("add" not "adds" or "added")
- Be specific and concise
- Focus on what, not how

**Examples**:
- `feat: add autoscaling for CPU metrics`
- `fix: resolve race condition in scaling engine`
- `refactor: simplify event generator aggregation logic`
- `docs: update deployment instructions for MTA`
- `test: add integration tests for scheduler component`

### Step 6: Generate PR Description
**Structure**:
```markdown
## Summary
- High-level bullet point 1 (what problem does this solve?)
- High-level bullet point 2 (what is the approach?)
- High-level bullet point 3 (any important context?)

## Changes
- Key technical change 1 (with file references if relevant)
- Key technical change 2
- Key technical change 3

## Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated (if applicable)
- [ ] Manual testing completed
- [ ] Documentation updated (if applicable)

🤖 Generated with [Claude Code](https://claude.com/claude-code)
```

**Description Rules**:
- Focus on "why" not just "what"
- Reference key files/components (e.g., "Updated api/cmd/api/main.go")
- Include testing guidance
- Keep it scannable with bullets and clear sections
- Mention breaking changes or migration steps
- Reference key components/modules in the project

### Step 7: Determine PR Label

Select exactly **one** label for release notes using this priority order:
1. `breaking-change` - Breaking backward compatibility
2. `dependencies` - Primary purpose is dependency updates
3. `bug` - Fixing a bug
4. `enhancement` - New features or improvements
5. `chore` - Maintenance, configs, tooling, or documentation

**Examples**:
- New feature added → `enhancement`
- Fix race condition → `bug`
- Update documentation → `chore`
- Bump dependency versions → `dependencies`
- Change API interface incompatibly → `breaking-change`

### Step 8: Create or Update PR
**If PR exists**:
- Update: `gh pr edit <number> --title "..." --body "..."`
- Add label: `gh pr edit <number> --add-label "<label>"`

From bonzofenix/skills, MIT.

More from bonzofenix/skills