git-commit

Generate conventional commit messages with type, scope, and subject.

5|1|Updated Aug 18, 2024
One-click install
npx skills add https://github.com/jbuckmccready/dotfiles --skill git-commit-jbuckmccready
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit
Source: https://github.com/jbuckmccready/dotfiles/tree/main/claude/.claude/skills/git-commit
Command: npx skills add https://github.com/jbuckmccready/dotfiles --skill git-commit-jbuckmccready

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps software teams enforce consistent, readable commit messages by guiding the user to follow the Conventional Commits format for every change.

Core Features & Use Cases

  • Conventional Commit Format Enforcement: Ensure messages follow type(scope): subject.
  • Guided Decision Making: Suggest inclusion of a body for multi-file changes and provide reasons when significant changes occur.
  • Useful Examples: Show common types and scopes to speed up messaging.
  • Use Case: You just implemented a feature in the UI. Use this Skill to generate a compliant commit message like feat(ui): add improved color contrast for header and attach a meaningful description to explain the change.

Quick Start

Propose a conventional commit message for the current repository changes using the guidelines. Example: "feat(auth): add OAuth2 login flow"

Frequently Asked Questions about git-commit

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

FAQPage Schema
How do I write consistent git commit messages across my team?

Conventional Commits enforce a standard format—type(scope): subject—across all repository changes. This format makes commit history readable, enables automation, and helps teams quickly understand what changed and why. Use this Skill to generate compliant messages like `feat(auth): add OAuth2 login flow` for every commit.

What is the Conventional Commits format and why should I use it?

Conventional Commits is a specification that structures commit messages as type(scope): subject with optional body. It clarifies whether changes are features, fixes, refactors, or docs, making version control history searchable and enabling tools to automate changelog generation and semantic versioning.

How do I create a commit message for multiple file changes?

When staging files across multiple areas, include a body in your commit message to explain the broader context and impact. This Skill suggests including a body for multi-file changes and guides you to structure it meaningfully, ensuring downstream reviewers understand the full scope of your changes.

What commit types and scopes should I use for my project?

Common types include feat (feature), fix (bug fix), refactor, docs, and deploy. Scopes identify the affected area—ui, auth, api, database—specific to your project. This Skill provides examples and helps you choose the right combination based on your staged changes and repository context.

Can I enforce commit message format automatically across my repository?

This Skill enforces Conventional Commits format by inspecting staged files and guiding you to structure each message correctly. While this Skill provides real-time guidance, teams often pair it with pre-commit hooks or CI checks to block non-compliant messages before they reach version control.

When should I include a body in my commit message?

Include a body when changes span multiple files, affect significant functionality, or need context beyond the subject line. This Skill automatically suggests a body for multi-file commits and explains when substantial changes warrant detailed explanation to help future maintainers understand the reasoning behind the change.