commit

Write commit messages following the Conventional Commits specification.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent commit messages make it hard to understand project history, complicate changelogs, and hinder automated release processes.

Core Features & Use Cases

  • Enforces Conventional Commits structure: type, optional scope, and a descriptive message.
  • Provides examples & templates: helps teams adopt consistent patterns across features, fixes, docs, and chores.
  • Supports PR reviews & changelogs: standardized messages enable reliable release notes and automation.

Quick Start

Use the conventional commits format to craft a clear commit message for the next change, e.g., feat(auth): add login capability.

Frequently Asked Questions about commit

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

FAQPage Schema
What is a conventional commit message and when do I need to use it?

A conventional commit message follows a specification defining type, scope, and description formatting. You need conventional commits to standardize project history, enable reliable changelogs, and support automated release processes across software workflows.

How do I write a conventional commit message for a feature or fix?

To write a conventional commit message, structure it with a type, optional scope, and descriptive message. For example, use feat(auth): add login capability for features, or fix(api): resolve timeout error for bug fixes, applying best-practice templates.

How do conventional commits support PR reviews and automated changelogs?

Conventional commits support PR reviews and changelogs by enforcing standardized type, scope, and description formatting. This consistent structure enables reliable release notes generation and allows automation tools to parse breaking changes and project history accurately.

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

To indicate a breaking change in a conventional commit, apply the specification's breaking-change handling guidelines within the optional body or description formatting. This ensures automated release processes correctly detect and document the breaking change.

Can I use conventional commits across different software projects and teams?

Yes, you can use conventional commits across different software projects, teams, and workflows. The specification provides guidelines and best-practice templates that help teams adopt consistent patterns for features, fixes, docs, and chores regardless of project context.

Why does inconsistent git workflow documentation complicate version control?

Inconsistent git workflow documentation complicates version control because irregular commit messages make it hard to understand project history, hinder automated release processes, and complicate changelog generation across software projects.