grokkit/docs/user-guide/pr-describe.md

# 📋 PR-Describe Guide

The `pr-describe` command generates a professional Pull Request title and a detailed body by analyzing the diff between your current branch and a base branch.

### Key Features

- **Automated PR Descriptions**: Saves time by drafting the entire PR description for you.
- **Context-Aware**: Analyzes every change on your branch to explain the "what" and "why."
- **Professional Format**: Includes sections for changes, motivation, and testing notes.
- **Customizable Base**: Compare against any branch (defaults to `master`).

### Usage

```bash
# From current branch vs master
grokkit pr-describe

# Compare against a specific base branch
grokkit pr-describe --base main

# With specific model
grokkit pr-describe -m grok-4
```

**Output includes:**
- Title suggestion
- Summary of changes
- Motivation/context
- Testing notes

### Options

| Flag | Description |
|------|-------------|
| `--base`, `-b` | Base branch to compare against (default: `master`) |
| `--model`, `-m` | Override the default model (e.g., `grok-4`) |

### How it Works

1. **Diff Generation**: Grokkit runs `git diff <base>..HEAD` to identify all changes on your current branch.
2. **AI Analysis**: It sends the full diff to Grok with a specialized prompt for PR generation.
3. **Structured Output**: Grok returns a professional PR title and body.
4. **Streaming Results**: You see the description as it's being generated.

### Best Practices

- **Keep branches focused**: PR descriptions are most effective when the branch addresses a single feature or fix.
- **Review and edit**: Use the AI-generated description as a strong starting point, then add any specific internal context or links (e.g., Jira tickets).
- **Model selection**: For large PRs with many changes, use a more powerful model like `grok-4` for a better high-level summary.