commit-formatter

Format git commit messages according to the Conventional Commits specification.

Updated Nov 4, 2025
One-click install
npx skills add https://github.com/jgardner04/claude-skills-skill --skill commit-formatter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-formatter
Source: https://github.com/jgardner04/claude-skills-skill/tree/main/.claude/skills/commit-formatter
Command: npx skills add https://github.com/jgardner04/claude-skills-skill --skill commit-formatter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent or poorly formatted Git commit messages can hinder code review, changelog generation, and project history analysis. This Skill ensures all commits adhere to the Conventional Commits specification, making your repository history clean, understandable, and easily parsable by automated tools.

Core Features & Use Cases

  • Guided Commit Formatting: Provides step-by-step instructions for crafting commit messages, including appropriate types (e.g., feat, fix), optional scope, concise descriptions, detailed bodies, and relevant footers (like issue references).
  • Conventional Commits Enforcement: Helps users apply industry-standard commit types and structure, promoting best practices in version control.
  • Use Case: When you've finished a new feature or bug fix and need to commit your changes, use this Skill to generate a perfectly formatted commit message that clearly communicates your work to your team and future self, streamlining collaboration and project management.

Quick Start

Ask Claude: Help me format a commit message for a new feature that adds user authentication.

Frequently Asked Questions about commit-formatter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format Git commit messages according to Conventional Commits?

Conventional Commits format requires a type (feat, fix, etc.), optional scope in parentheses, and a concise description under 50 characters. Add a body with 72-character line wrapping and footers for breaking changes or issue references. This standardizes commit history for automated changelog generation and team collaboration.

What are the benefits of standardizing commit messages in my repository?

Standardized commits using Conventional Commits improve code review clarity, enable automated changelog generation, and make project history easily parsable by tools. Consistent formatting communicates changes effectively to your team and future maintainers.

Can I use Conventional Commits for existing repositories with inconsistent commit history?

Yes, Conventional Commits applies to creating new commits, updating existing messages, and validating formatting. You can gradually migrate your repository history by reformatting commits as needed or adopting the standard for all future commits moving forward.

How do I structure a commit message with a scope and breaking change?

Use the format: type(scope): description. Include breaking change markers in the footer (e.g., BREAKING CHANGE:) to flag significant impacts. The body provides detailed context with 72-character wrapping, and footers reference issues or document breaking changes.

Why should I limit commit subject lines to 50 characters?

A 50-character subject line ensures readability in git log summaries and email notifications where longer lines truncate. This constraint forces clear, concise descriptions and aligns with Conventional Commits best practices for maintainable version control.

Does Conventional Commits support issue references and linking?

Yes, issue references appear in commit footers (e.g., Closes #123, Refs #456) following Conventional Commits specification. This links commits to issue tracking systems and supports automated workflow integration for project management.