commit-review

# commit-review

Bring AI-powered commit intelligence to your git workflow. commit-review analyzes your staged changes, understands the intent behind them, generates conventional commit messages, catches issues before they land in history, and keeps your repository clean and reviewable.

## What It Does

commit-review integrates with your local git repository to provide a full commit intelligence pipeline:

- **Diff analysis**: Reads staged and unstaged changes, understands what was modified and why
- **Conventional commit generation**: Produces messages following the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/) specification (feat, fix, refactor, chore, docs, test, perf, ci, build, revert)
- **Issue detection**: Flags debug statements, TODO comments, hardcoded secrets, large binary files, dependency lockfile-only changes, and breaking API changes
- **Scope inference**: Automatically determines the scope from changed file paths and module structure
- **Breaking change detection**: Identifies API signature changes, removed exports, and schema mutations
- **Multi-commit splitting**: Suggests how to split large mixed-concern diffs into atomic commits
- **PR description generation**: Converts a series of commits into a pull request summary

## Installation

```bash
anvil skill install commit-review
```

## Usage

### Review Staged Changes and Generate Commit Message
```
/commit-review
```

### Review with Specific Type Hint
```
/commit-review --type fix
```

### Review and Auto-commit
```
/commit-review --auto-commit
```

### Review Unstaged Changes Too
```
/commit-review --all
```

### Generate PR Description from Branch
```
/commit-review pr --base main
```

### Lint Existing Commit History
```
/commit-review lint HEAD~10..HEAD
```

## Configuration Options

| Option | Description | Default |
|--------|-------------|---------|
| `--type` | Force a commit type (feat, fix, etc.) | auto-detect |
| `--scope` | Force a scope | auto-detect |
| `--auto-commit` | Stage and commit without confirmation | false |
| `--all` | Include unstaged changes in analysis | false |
| `--breaking` | Mark as breaking change | auto-detect |
| `--co-authors` | Add co-author trailers | none |
| `--sign` | GPG-sign the commit | false |

## Configuration File

Create `.commitreview.json` in your project root:

```json
{
"maxSubjectLength": 72,
"enforceScope": true,
"allowedTypes": ["feat", "fix", "docs", "refactor", "test", "chore"],
"breakingChangePatterns": ["BREAKING CHANGE", "!"],
"ignorePatterns": ["*.lock", "dist/*"]
}
```

## Requirements

- Git repository with at least one commit
- Staged changes (run `git add` first, or use `--all` flag)