git-commit-formatter_skill

Overview

This skill formats git commit messages to follow the Conventional Commits specification. It produces a single-line header with optional scope and an imperative description, and it can add a BREAKING CHANGE footer when needed. Use it whenever you create or refine commit messages to keep project history consistent and machine-readable.

How this skill works

The tool inspects the nature of changes to determine the appropriate commit type (feat, fix, docs, etc.). It suggests an optional scope based on modified components or files and composes a concise, imperative description. If a breaking API or behavior change is detected, it appends a BREAKING CHANGE footer with a short explanation.

When to use it

• Committing new code or bug fixes
• Writing commit messages for pull requests
• Standardizing commit history across a team
• Preparing commits for automated changelog generation
• When merging feature branches into main or release branches

Best practices

• Choose the single primary type that best describes the change
• Keep the description short and in imperative mood (e.g., "add", "fix")
• Include a scope when the change targets a specific module or file
• Add a BREAKING CHANGE footer for API or behavioral changes with details
• Use present-tense, active verbs and avoid issue numbers in the header

Example use cases

• feat(auth): implement login with Google
• fix(parser): handle empty input without exception
• docs: update README with setup instructions
• refactor(db): normalize query builder to improve readability
• perf(cache): reduce memory usage for large result sets