# commit-helper

Formats git commits and pull requests according to CockroachDB conventions. Analyzes diffs, checks line lengths, and enforces release note categories.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 642 installs · ★ 32579
- Author: cockroachdb
- License: LicenseRef-Unknown · policy=link-only · description only; the file stays with the author
- Source: https://github.com/cockroachdb/cockroach/tree/HEAD/.claude/skills/commit-helper/SKILL.md
- Updated: 2026-10-21
- HTML: https://affpapa.org/en/nevibecode/skills/cockroachdb-commit-helper

## What it does

The skill automates git commit creation in line with CockroachDB repository guidelines. It inspects diffs via `git diff` to identify the affected package. Then it requests the issue identifier. The agent also verifies whether a release note is necessary.

Subject lines follow an imperative mood without a period, staying under 72 characters. The message body explains why the code changed and compares behavior before and after. Issue links like `Resolves: #123` attach at the end. Every commit requires an explicit release note entry. Internal refactors use `None`, while visible changes demand an exact category such as `bug fix` or `sql change`.

Commits without a valid release note category fail repository guidelines. For pull requests, the skill aligns single-commit PR bodies with the commit message and summarizes multi-commit branches.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add cockroachdb/cockroach --skill commit-helper -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/commit-helper/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/commit-helper/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add cockroachdb/cockroach --skill commit-helper -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/commit-helper/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add cockroachdb/cockroach --skill commit-helper -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/commit-helper/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install cockroachdb/cockroach commit-helper
```

2. **Manually: put the files in place**
- File: `.github/skills/commit-helper/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add cockroachdb/cockroach --skill commit-helper -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/cockroachdb/cockroach --path .claude/skills/commit-helper
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/commit-helper/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add cockroachdb/cockroach --skill commit-helper -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/cockroachdb/cockroach/tree/HEAD/.claude/skills/commit-helper/SKILL.md

## When to use it
- format git commits following CockroachDB conventions
- assign validated release note categories to changes
- link commits to issue and epic trackers
- generate structured single-commit and multi-commit pull request summaries

## Example prompts
- Create a commit for the staged changes with a release note
- Format my commit according to CockroachDB guidelines for issue #123
- Draft a pull request description summarizing the recent commits

## Similar
- [triage](https://affpapa.org/en/nevibecode/skills/triage.md) — skill · 990453 installs
- [code-review](https://affpapa.org/en/nevibecode/skills/code-review.md) — skill · 789521 installs
- [implement](https://affpapa.org/en/nevibecode/skills/implement.md) — skill · 774700 installs
- [git-guardrails-claude-code](https://affpapa.org/en/nevibecode/skills/git-guardrails-claude-code.md) — skill · 499069 installs
- [setup-pre-commit](https://affpapa.org/en/nevibecode/skills/setup-pre-commit.md) — skill · 489289 installs
- [scaffold-exercises](https://affpapa.org/en/nevibecode/skills/scaffold-exercises.md) — skill · 480196 installs

## Other versions with the same name
- [commit-helper · zhaono1](https://affpapa.org/en/nevibecode/skills/commit-helper.md) — 699 installs

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md