git-conventional-commit

Drafts precise Conventional Commit messages for staged diffs with configurable formatting rules.

3|Updated Mar 22, 2026
One-click install
npx skills add https://github.com/0xharryriddle/codex-field-kit --skill git-conventional-commit-0xharryriddle
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-conventional-commit
Source: https://github.com/0xharryriddle/codex-field-kit/tree/main/archive/upstream/chasebuild-agent-skills/git/skills/git-conventional-commit
Command: npx skills add https://github.com/0xharryriddle/codex-field-kit --skill git-conventional-commit-0xharryriddle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Conventional commits enforce a standard structure for commit messages (type(scope)!: short summary) to improve readability and tooling compatibility.

Core Features & Use Cases

  • Enforces the Conventional Commits format for staged changes and ensures checks pass before commit.
  • Provides a helper script at ./scripts/compose-conventional-commit.sh to draft a commit skeleton.
  • Guides users through choosing the narrowest type and scope, keeping subject lines concise, and adding a BREAKING CHANGE footer when needed.

Quick Start

Prompt the AI or your editor to draft a conventional commit message for the currently staged changes.

Frequently Asked Questions about git-conventional-commit

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

FAQPage Schema
How do I generate conventional commit messages for staged Git changes?

To generate conventional commit messages for staged Git changes, prompt the AI to analyze your staged diffs and draft a type(scope)!: summary structure. A helper script at ./scripts/compose-conventional-commit.sh can also generate a commit skeleton automatically.

What is the conventional commit format for Git version control?

The conventional commit format for Git version control enforces a standard structure of type(scope)!: short summary to improve readability and tooling compatibility. It requires choosing the narrowest type and scope while keeping subject lines concise.

How do I add a BREAKING CHANGE footer to a conventional commit?

To add a BREAKING CHANGE footer to a conventional commit, guide the AI to append the breaking-change guidance to your drafted message when major modifications are detected in the staged diff. This ensures pre-commit checks pass successfully.

Can I use a shell script to draft conventional commit skeletons automatically?

Yes, you can use a shell script to draft conventional commit skeletons automatically. The Skill provides a helper script at ./scripts/compose-conventional-commit.sh specifically designed to generate the initial commit message structure for your workflow.

Does this conventional commit workflow require any external Git dependencies?

No, this conventional commit workflow does not require any external Git dependencies. It operates independently to analyze staged changes and draft messages that satisfy type, scope, and breaking-change guidance without additional package installations.

Why do my conventional commit pre-commit checks keep failing?

Your conventional commit pre-commit checks keep failing because the message structure likely violates the required type(scope)!: summary format. Using the AI to draft the message or the helper script ensures the narrowest type and concise subject line are applied correctly.