commit

Generate conventional commit messages with type, kebab-case scope, and imperative subject.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill removes the friction and inconsistency of writing commit messages by guiding you to produce Conventional Commits with a correct type, required scope, and a clear subject line.

Core Features & Use Cases

  • Conventional Commits formatting: Creates commit messages in the form type(scope): subject with scope enforced in kebab-case and subject rules (imperative, max length, no trailing period).
  • Body guidance for complex changes: Produces a structured explanation of HOW/WHY plus references (Tasks/Requirements) and optional trailers (e.g., Fixes, Co-authored-by).
  • Safety guardrails: Encourages avoiding secrets and sensitive files and discourages generic or vague commit messages.
  • Common scenarios: Use for regular development commits, test/ci/documentation updates, maintenance chores, and breaking-change PR workflows.

Quick Start

Tell Claude to write a Conventional Commit message for the staged changes, including a type, required kebab-case scope, subject line, and (if needed) a clear body with HOW/WHY and a reference to the task or requirement.

Frequently Asked Questions about 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, provide the staged changes to get output formatted as `type(scope): subject` with a required kebab-case scope and an imperative subject line. This ensures consistent software maintenance history across your repository.

What is the correct format for a conventional commit scope and subject?

The correct format for a conventional commit requires a type, a kebab-case scope, and a concise imperative subject line with no trailing period. This structure standardizes commit messages for automated release notes generation.

Can I include a body and trailers like Co-authored-by in a conventional commit?

Yes, you can include a structured body explaining how or why changes were made, alongside optional trailers like Fixes or Co-authored-by. This adds necessary context for complex software development updates and pull requests.

How do I indicate a breaking change in a conventional commit message?

To indicate a breaking change, the conventional commit message uses specific type formatting and structured body guidance. This clearly signals breaking changes for CI workflows and release notes generation.

What should I avoid when writing conventional commit messages for a pull request?

When writing conventional commit messages, you should avoid committing secrets, including sensitive files, and writing generic or vague subjects. Safety guardrails prevent exposing sensitive data in your Git repository history.