Conventional Commits

Enforce Conventional Commits formatting for commit messages with type, scope, and syntax rules.

Updated May 13, 2025
One-click install
npx skills add https://github.com/GolferGeek/orchestrator-ai --skill conventional-commits-golfergeek
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Conventional Commits
Source: https://github.com/GolferGeek/orchestrator-ai/tree/main/.claude/skills/conventional-commits-skill
Command: npx skills add https://github.com/GolferGeek/orchestrator-ai --skill conventional-commits-golfergeek

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill enforces the Conventional Commits specification for all commit messages, improving changelog generation, project history, and collaboration.

Core Features & Use Cases

  • Format enforcement: Type(scope): description is required for every commit.
  • Examples and guidance: Shows common commit types and scopes to help writers craft messages.
  • Flexible structure: Supports optional body and footer for additional context.

Quick Start

Example: git commit -m 'feat(api): add user authentication' (Include a body or footer as needed, e.g. after the main line)

Frequently Asked Questions about Conventional Commits

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

FAQPage Schema
How do I format commit messages using conventional commits?

Conventional commits use the format type(scope): description—for example, feat(api): add user authentication. Type must be one of feat, fix, chore, docs, test, refactor, style, or perf. Scope is optional and describes the area affected. A body and footer can follow the main line for additional context.

What types of commits does the conventional commits specification support?

The specification defines eight standard types: feat for new features, fix for bug fixes, chore for maintenance, docs for documentation, test for tests, refactor for code restructuring, style for formatting changes, and perf for performance improvements. Each type signals the nature of the change in your project history.

Why should I enforce conventional commit formatting in my Git workflow?

Enforcing conventional commits improves changelog generation, makes project history readable, and enables better collaboration across teams. Consistent formatting lets tools automatically extract breaking changes, categorize commits, and generate release notes from your Git history.

Can I add extra details to a conventional commit message?

Yes. After the main line—type(scope): description—you can add a body for detailed explanation and a footer for metadata like breaking-change notation. The body and footer are optional but useful for documenting why a change was made or flagging significant impacts.

Do conventional commits work across different development teams and CI workflows?

Conventional commits apply across APIs, modules, features, and CI workflows, making them suitable for team projects of any scale. The standard format and breaking-change notation ensure consistency whether commits come from individual developers or automated processes in your pipeline.