conventional-commit

Create Conventional Commits v1.0.0-compliant git commit messages.

8|2|Updated Jun 4, 2024
One-click install
npx skills add https://github.com/cmd-llm/cllm --skill conventional-commit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/cmd-llm/cllm/tree/main/.claude/skills/conventional-commit
Command: npx skills add https://github.com/cmd-llm/cllm --skill conventional-commit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps create git commits following the Conventional Commits specification v1.0.0. It ensures commits have a consistent format, proper scope, and clear breaking-change indicators.

Core Features & Use Cases

  • Commit type determination: feat, fix, docs, style, refactor, perf, test, build, ci, chore
  • Optional scope: include a scope like api, parser, ui for clarity
  • Breaking change indicator: add "!" and a BREAKING CHANGE footer when needed
  • Structured commit creation: commit message formatted as per Conventional Commits
  • Reproducible workflow: use a heredoc to craft the final message

Quick Start

Stage your changes (e.g., git add -A) and create a conventional commit with a prepared body, for example: git commit -m "$(cat <<'EOF' feat(api)!: add OAuth2 login support

This introduces OAuth2-based authentication and updates the API surface. BREAKING CHANGE: The authentication flow now requires OAuth2 tokens for all clients. Refs: #123 EOF )"

Frequently Asked Questions about conventional-commit

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

FAQPage Schema
How do I create git commits that follow a standard format?

Conventional Commits enforce a standardized format for git commit messages with type, scope, and description. Use this Skill to structure commits as type(scope): description, ensuring consistency across your repository and enabling automated versioning and changelog generation.

What is the Conventional Commits specification and why does it matter?

Conventional Commits v1.0.0 is a specification for commit message structure that enables parsing commit history programmatically. It distinguishes features, fixes, and breaking changes, making it essential for automated versioning, release notes, and maintaining clean project history.

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

Add an exclamation mark after the scope (type(scope)!) and include a BREAKING CHANGE footer in the commit body. This Skill ensures proper breaking-change formatting so downstream automation recognizes major version bumps and alerts consumers of API changes.

Can I use conventional commits in automated pipelines and CI workflows?

Yes, conventional commits work across manual commits and automated pipelines. This Skill formats messages so CI/CD systems can parse commit type and scope to trigger builds, generate changelogs, and enforce semantic versioning automatically.

What commit types does the Conventional Commits format support?

Conventional Commits defines types: feat, fix, docs, style, refactor, perf, test, build, ci, and chore. This Skill enforces proper type selection, lowercase descriptions, optional scopes, and footer formatting per the v1.0.0 specification for consistent repository history.

Do I need to know bash to create conventional commits with this Skill?

The Skill uses bash heredoc syntax to craft formatted messages, so familiarity with bash is helpful but not required. You stage changes with git add and invoke the Skill via command line; it handles the message structure and formatting.