conventional-commit

Original：🇺🇸 English
Translated

Conventional Commits v1.0.0 standards for git messages. Use when (1) creating git commits, (2) writing or drafting commit messages, (3) reviewing commit message format, (4) explaining commit conventions, or (5) validating commit message compliance.

1installs
Sourcejkappers/agent-skills
Added on

NPX Install

npx skill4agent add jkappers/agent-skills conventional-commit

Tags

Translated version includes tags in frontmatter
git-commitconventional-commitsversion-controlcommit-messagegit-workflow

SKILL.md Content

View Translation Comparison →

Commit Authoring

Create git commits following Conventional Commits v1.0.0.
When invoked with arguments, commit staged changes with a message for: $ARGUMENTS
This skill applies only to git commit messages. Do not apply these conventions to PR titles, branch names, changelog entries, or release notes unless explicitly requested.

Workflow

  1. Run 
    git diff --cached
    to inspect staged changes
  2. If no staged changes exist, report this and stop
  3. Analyze the diff to determine the appropriate type, scope, and description
  4. Compose the commit message following the rules below
  5. Run 
    git commit -m "<message>"
    (use a HEREDOC for multi-line messages)
  6. Do not stage files. Only commit what is already staged.

Message Structure

text
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types

TypePurpose
feat
New feature
fix
Bug fix
docs
Documentation only
style
Formatting, whitespace
refactor
Neither fix nor feature
perf
Performance improvement
test
Adding or updating tests
build
Build system or dependencies
ci
CI configuration
chore
Maintenance tasks

Scopes

Scope is optional. When used, set it to the module, component, or area of the codebase affected.
Derive scopes from the project structure. Use directory names or module names, not file names.
Examples: 
feat(auth):
, 
fix(api):
, 
docs(readme):
, 
refactor(db):
Omit scope when the change is cross-cutting or affects the project root.

Description

Use imperative mood: "add feature" not "added feature" or "adds feature". Lowercase the first letter after the type prefix. Omit trailing period. Limit to 50 characters.

Body

Wrap at 72 characters. Explain what changed and why, not how.
Separate the body from the description with one blank line.
Use the body for context the diff alone does not convey: motivation, trade-offs, or constraints that influenced the approach.

Prohibited Content

Do not include any of the following in commit messages:
  • AI attribution ("Generated with Claude Code", "Co-authored-by" lines for AI)
  • Emoji in type prefixes or descriptions
  • Time estimates or dates
  • TODO items or future work references
  • File lists (the diff already shows what changed)
  • Apologies or hedging ("try to fix", "hopefully resolves")

Examples

Simple:
text
docs: correct spelling of CHANGELOG
With scope:
text
feat(lang): add Polish language
Breaking change:
text
feat!: send email to customer when product ships

BREAKING CHANGE: customers now receive emails by default.
With body:
text
fix: prevent duplicate form submissions

Disables submit button after first click and adds
debounce to the handler.
With footer:
text
fix: resolve race condition in auth flow

Refs: #123
Reviewed-by: Alice