commit

Enforce Conventional Commits formatting for git commit messages.

Updated Aug 29, 2023

Search Tags:#git #versioning #commit #breaking-changes #conventional-commits #scopes

Ready to run

npx skills add https://github.com/SaschaLeh/dotfiles --skill commit-saschaleh

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/SaschaLeh/dotfiles/tree/main/dot_claude/skills/commit
Command: npx skills add https://github.com/SaschaLeh/dotfiles --skill commit-saschaleh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

writing consistent commit messages helps teams understand history, reduces noise, and enables automated versioning and changelog generation. It enforces a standardized structure across commits to communicate intent, scope, and impact without reading full code changes.

Core Features & Use Cases

Conventional types: support for feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert.
Scoped messages: optional scope to contextualize changes (e.g., feat(auth)).
Breaking changes: clear indication of breaking changes via exclamation marks or BREAKING CHANGE footers.
Descriptive descriptions: guidelines to keep messages concise, imperative, and under 72 characters with a descriptive WHAT, not HOW.

Quick Start

Craft a conventional commit message for a new authentication feature.

Frequently Asked Questions about commit

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

FAQPage Schema

How do I write a conventional commit message for breaking changes?▼

To write a conventional commit message for breaking changes, add an exclamation mark before the colon, such as `feat(scope)!`, or include a `BREAKING CHANGE` footer in the commit body to clearly describe the impact.

What is the conventional commits specification used for in git versioning?▼

The conventional commits specification standardizes git commit messages using structured types like feat and fix to communicate intent and scope, enabling automated versioning and changelog generation without requiring teams to read full code changes.

How do I format a scoped conventional commit for a feature?▼

Format a scoped conventional commit by placing the scope in parentheses directly after the type, such as `feat(auth): add login validation`, to contextualize changes while keeping the description concise, imperative, and under 72 characters.

Which commit types are supported by the conventional commits standard?▼

The conventional commits standard supports types including feat, fix, docs, style, refactor, perf, test, build, ci, chore, and revert to categorize the nature of code changes across a software project.

Does conventional commits work for automating release notes and changelogs?▼

Yes, conventional commits works for automating release notes and changelogs because the standardized structure clearly distinguishes features, fixes, and breaking changes, allowing automated tools to parse history and generate version bumps accurately.