Back to Skills

conventional-git

Conventional Commits v1.0.0 branch naming, worktree naming, and commit message standards for GitHub and GitLab projects. Use when creating branches, naming worktrees, writing commits, generating commit messages, reviewing branch conventions, or setting up changelog automation. Apply when your project needs consistent git history, SemVer-driven releases, parseable changelog generation, or automatic issue closing. Trigger when the user asks how to name a worktree, create a git worktree, or organiz

145stars10forksUpdated 6/25/2026

Security Assessment

Safe(100/100)
Security Score100/100

About conventional-git

Defines Conventional Commits v1.0.0 standards for branch names, git worktree names, and commit messages across GitHub and GitLab projects, so tooling can auto-generate changelogs, enforce SemVer bumps, and filter history by concern. Apply it when creating branches, naming worktrees, writing or generating commit messages, reviewing branch conventions, or setting up changelog automation, and whenever a project needs consistent git history, SemVer-driven releases, parseable changelogs, or automatic issue closing. It is designed for Claude Code or similar AI coding agents and requires git.

Branch names follow '<type>/[issue-]<description>' in lowercase with hyphens only, prefixed with an issue number when one exists so GitHub and GitLab auto-link it, and kept under 50 characters. Worktrees are treated as local checkout directories that never reach the remote: they live under .claude/worktrees/ and mirror the branch name with the slash replaced by a hyphen, and the skill is explicit that 'worktree' must never appear in a branch name. It advises running 'git worktree list' before creating a new one, keeping worktrees scoped to a single branch, and removing them once the branch is merged, with 'git worktree remove' and 'git worktree prune' commands provided.

Commit messages use the standard '<type>[optional scope]: <description>' header with optional body and footers. A type table maps each type (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert) to its SemVer impact and intended use. Rules require subject lines of 72 characters or fewer, imperative mood, no capital letter or trailing period, a blank line before the body, and explicit breaking-change signaling via '!' or a 'BREAKING CHANGE:' footer. Notably, it instructs never to add a Claude signature, AI agent attribution, or Co-authored-by trailer for any AI agent. It also documents closing issues through footer keywords (close/fix/resolve variants) on the default branch, including cross-repo and multiple-issue forms, and warns that squash merges take the PR title as the commit message, so the title must follow the convention.

FAQ

What format should branch names follow?

'<type>/[issue-]<description>' in lowercase with hyphens only, for example feat/42-user-authentication. Prefix with the issue number when one exists and keep the description under 50 characters.

Where should git worktrees be placed and how are they named?

Under .claude/worktrees/, named by mirroring the branch name with the slash replaced by a hyphen. The word 'worktree' must never appear in a branch name, since worktrees are a local checkout mechanism.

Does this skill add a Co-authored-by trailer for AI agents?

No. It explicitly instructs never to add a Claude signature, AI agent attribution, or Co-authored-by trailer for Claude or any other AI agent to commits.

How do I mark a breaking change in a commit?

Use a '!' after the type or scope, or add a 'BREAKING CHANGE:' footer, which triggers a MAJOR version bump. A breaking change described only in the body is invisible to changelog tools.

How can a commit close an issue automatically?

Place a keyword like Closes, Fixes, or Resolves with the issue reference in the footer; it triggers when merged into the default branch. Cross-repo and multiple-issue forms such as 'Closes owner/repo#42' are supported.

All Files

2 files
evals/evals.json12.1 KB
View
SKILL.md7.2 KB
View

Install conventional-git

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill