conventional-commit

Generate Git commit messages conforming to the Conventional Commits specification.

1|Updated Mar 25, 2025
One-click install
npx skills add https://github.com/ramtinJ95/dotfiles --skill conventional-commit-ramtinj95
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/ramtinJ95/dotfiles/tree/main/mac-config/mac-dotfiles/claude/.claude/skills/conventional-commit
Command: npx skills add https://github.com/ramtinJ95/dotfiles --skill conventional-commit-ramtinj95

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill standardizes Git commit messages to conform with the Conventional Commits specification.

Core Features & Use Cases

  • Enforces required fields: type and subject in imperative mood.
  • Supports optional scope, body, and footer for breaking changes and references.
  • Guides users through examples and rules for consistent messaging across a codebase.

Quick Start

Generate a conventional commit message for a new authentication feature with type feat and optional scope, following the Conventional Commits format.

Frequently Asked Questions about conventional-commit

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

FAQPage Schema
How do I write a conventional commit message for a new feature?

A conventional commit requires a lowercase type prefix like 'feat' or 'fix' and a subject in imperative mood. This enforces consistent messaging across your Git workflow, supporting optional scopes, bodies, and footers for breaking changes.

What is the maximum character limit for a conventional commit subject?

The maximum character limit for a conventional commit subject is 70 characters. Enforcing this length ensures consistent messaging and clean Git logs across your codebase.

How do I indicate breaking changes in a conventional commit?

You indicate breaking changes in a conventional commit by adding an exclamation mark after the type or scope. You can also use the message footer to document specific breaking change notes and references.

Does this conventional commit format support optional scopes and footers?

Yes, the conventional commit format supports optional scopes and footers. Scopes categorize the commit area, while footers document breaking changes and issue references without affecting the maximum 70-character subject.

When do I need to use conventional commits in my Git workflow?

You need to use conventional commits in your Git workflow when you require consistent commit messaging for automated CI release notes. This specification standardizes features, fixes, docs, and chores across a codebase.