Agent skill

Conventional Commits

by awattar in awattar/claude-code-best-practices

A skill your agent uses when writing git commit messages in this repository.

MITAuto-check passedDevelopment

Install Conventional Commits

skills CLI
$ npx skills add awattar/claude-code-best-practices --skill conventional-commits -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install awattar/claude-code-best-practices conventional-commits --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/awattar/claude-code-best-practices.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/conventional-commits .claude/skills/conventional-commits && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
conventional-commits
GitHub stars
263
Token cost
~395 tokens
SKILL.md length
157 words
Files
1
Skills in repo
1
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when writing git commit messages in this repository.

  • Writing git commit messages in this repository
  • SKILL.md covers Format, Rules and References
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Tasks that involve Commit messages

What it does

Conventional Commits is an agent skill from awattar/claude-code-best-practices. Use when writing git commit messages in this repository. Enforces the project's conventional commit format — type prefix, GitHub issue reference, and atomic commits — as defined in .gitmessage and .github/COMMITCONVENTION.md.

Its SKILL.md is about 400 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Commit messages. It works with GitHub. The repository describes itself as: 💻 Best practices and examples for using Claude Code - Anthropic’s terminal-native AI - for writing, editing, and refactoring code with deep project awareness, prompt design, and… The licence is MIT.

When your agent uses it

  • Writing git commit messages in this repository
  • Tasks that involve Commit messages

Example prompts

  • “/conventional-commits”

What it can do on your machine

Read from SKILL.md and the folder at commit 3456a85. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Conventional Commits loads about 395 tokens when it runs. Until then it costs about 62 tokens; SKILL.md has 157 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~62
When it runs · the whole SKILL.md, loaded when a task matches
~395

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from awattar/claude-code-best-practices at commit 3456a85, republished under its MIT licence (© awattar). 157 words, ~395 tokens.

Download SKILL.mdSave it as .claude/skills/conventional-commits/SKILL.md (or your agent's skills folder).
name
conventional-commits
description
Use when writing git commit messages in this repository. Enforces the project's conventional commit format — type prefix, GitHub issue reference, and atomic commits — as defined in .gitmessage and .github/COMMIT_CONVENTION.md.

Conventional Commits

When creating any git commit in this repository, follow the project's commit convention. Unlike the /commit command (which the user invokes explicitly), this skill applies automatically whenever a commit message is being authored.

Format

Single-line, when a GitHub issue applies:

<type>: (#<issue_number>) <issue_name> - <description>.

Single-line, when no GitHub issue applies:

<type>: <description>.

Multiline, when the change spans multiple concerns:

<type>: (#<issue_number>) <issue_name>:
- <description_line_1>.
- <description_line_2>.

Rules

  • <type> is exactly one of: New feature, Fix issue, Other.
  • Single-line messages end with .; the first line of a multiline message ends with :.
  • Every bullet starts with - and ends with ..
  • Use present tense, imperative mood ("add feature", not "added feature").
  • Keep commits atomic — one logical concern per commit. Split unrelated changes into separate commits.
  • NEVER add trailers such as "Generated with Claude Code", author info, or co-author lines.

References

  • Full template with examples: .gitmessage
  • Commit-splitting guidance and workflow integration: .github/COMMIT_CONVENTION.md
  • For an interactive, guided commit flow, use the /commit command.

© awattar, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/conventional-commits of awattar/claude-code-best-practices.

Open the folder on GitHubat commit 3456a85

Compare with similar skills

Conventional Commits next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Conventional Commits compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Conventional Commits this skillawattar/claude-code-best-practices263—~395Automated safety check: PassMIT
PR Finalize Reviewmicrosoft/garnet12k—~3.1kAutomated safety check: PassMIT
React Router Pull Request Creatorremix-run/react-router57k—~2.5kAutomated safety check: PassMIT
Verdaccio Pull Request Workflowverdaccio/verdaccio18k—~1.9kAutomated safety check: PassMIT
Gh PR Metadatamodule-federation/core2.7k—~1kAutomated safety check: PassMIT
Draft Pull Request Creatorwordpress-mobile/WordPress-Android3.2k—~881Automated safety check: NotesGPL-2.0

Similar skills

  • PR Finalize Review

    microsoft/garnet

    Official

    Checks that a pull request's title and description match its implementation and reviews the code for Garnet best practices, reporting findings without posting them.

    12k GitHub stars~3.1k tokensUpdated today
    DevelopmentAuto-check passed
  • React Router Pull Request Creator

    remix-run/react-router

    Packages finished React Router work into a draft pull request: branch, commit, push, a written PR body and the right GitHub labels.

    57k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Takes a change through a verdaccio pull request: branch, local checks, changeset, title and body, labels, CI and review rounds, and ports to other release lines.

    18k GitHub stars~1.9k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Gh PR Metadata

    module-federation/core

    Update the current GitHub PR title and body for this repository so they match the repo's pull request template and conventional-commit title style.

    2.7k GitHub stars~1k tokensUpdated today
    DevelopmentAuto-check passed
  • Draft Pull Request Creator

    wordpress-mobile/WordPress-Android

    Commits and pushes current changes, writes a pull request title and body from the branch history and template, and opens a draft PR on GitHub after you approve it.

    3.2k GitHub stars~881 tokensUpdated today
    DevelopmentAuto-check: notes
  • Submit PR

    tisfeng/Easydict

    创建或复用当前 checkout 已提交变更的 GitHub PR,必要时推送任务分支。PR 审查使用 review-pr;仅本地提交使用 git-commit。

    15k GitHub stars~595 tokensUpdated 3 days ago
    DevelopmentAuto-check passed

Works with

Categories

Questions about Conventional Commits

What does Conventional Commits do?

A skill your agent uses when writing git commit messages in this repository. Conventional Commits is an agent skill from awattar/claude-code-best-practices. Use when writing git commit messages in this repository.

When should I use Conventional Commits?

Conventional Commits fits situations like: writing git commit messages in this repository; tasks that involve Commit messages.

How do I install Conventional Commits in Claude Code?

Run `npx skills add awattar/claude-code-best-practices --skill conventional-commits -a claude-code`. Or copy the skill folder (.claude/skills/conventional-commits in awattar/claude-code-best-practices) into .claude/skills/conventional-commits in your project. Claude Code loads it when a task matches its description.

How do I install Conventional Commits in Codex?

Run `npx skills add awattar/claude-code-best-practices --skill conventional-commits -a codex`. Or copy the skill folder (.claude/skills/conventional-commits in awattar/claude-code-best-practices) into .agents/skills/conventional-commits in your project. Codex loads it when a task matches its description.

Can I use Conventional Commits in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add awattar/claude-code-best-practices --skill conventional-commits -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/conventional-commits, .gemini/skills/conventional-commits, .github/skills/conventional-commits and .opencode/skills/conventional-commits in your project.

What does Conventional Commits need to run?

SKILL.md names no scripts, command-line tools or credentials: Conventional Commits is instructions for the agent only.

Does Conventional Commits access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Conventional Commits safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Conventional Commits use?

Conventional Commits is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Conventional Commits use?

About 395 tokens (SKILL.md is roughly 1.6k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Conventional Commits?

Skills that share tags, products or a category with Conventional Commits: PR Finalize Review (microsoft/garnet, 12k stars), React Router Pull Request Creator (remix-run/react-router, 57k stars), Verdaccio Pull Request Workflow (verdaccio/verdaccio, 18k stars) and Gh PR Metadata (module-federation/core, 2.7k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Conventional Commits?

awattar (a GitHub user) maintains it in awattar/claude-code-best-practices, which has 263 GitHub stars. The repository was last updated on May 22, 2026.

Source: awattar/claude-code-best-practices on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.