conventional-commits

Generate structured Git commit messages with conventional types and scopes.

3|Updated Apr 5, 2023
One-click install
npx skills add https://github.com/mrp4sten/.dotfiles --skill conventional-commits-mrp4sten
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commits
Source: https://github.com/mrp4sten/.dotfiles/tree/main/development/IA/opencode/skill/conventional-commits
Command: npx skills add https://github.com/mrp4sten/.dotfiles --skill conventional-commits-mrp4sten

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Conventional commits provide a standard for semantic commit messages that enable automated tooling for changelog generation and semantic versioning.

Core Features & Use Cases

  • Standardized commit types (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert) to convey intent at a glance.
  • Optional scopes to contextualize changes (e.g., feat(api): add endpoint).
  • Built-in guidance for commit message structure and Keep a Changelog workflow to maintain release notes.
  • Practical examples show how to format commits and evolve changelogs over time.

Quick Start

Write your first commit using the conventional format to unlock automatic changelog updates and semantic versioning.

Frequently Asked Questions about conventional-commits

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

FAQPage Schema
How do I write conventional commit messages for automated changelog generation?

Conventional commit messages use standardized types like feat, fix, docs, and chore, combined with optional scopes, subjects, bodies, and footers to enable automated changelog generation and semantic versioning.

What is the conventional commits format for structuring semantic Git commit messages?

The conventional commits format structures semantic Git commit messages using specific types (feat, fix, refactor, etc.), an optional scope for context, a subject line, and optional body and footer sections for detailed history tracking.

How do I format a Git commit message to trigger automatic semantic versioning bumps?

To trigger automatic semantic versioning bumps, format Git commit messages starting with feat for minor version increments or fix for patch version increments, followed by a colon and descriptive subject.

Does the conventional commits standard support custom scopes for contextualizing commit types?

Yes, the conventional commits standard supports optional custom scopes enclosed in parentheses after the commit type, such as feat(api) or fix(parser), to contextualize changes within specific modules or components.

What's the best way to maintain release notes using Keep a Changelog alongside conventional commits?

Maintain release notes by applying the Keep a Changelog workflow alongside conventional commits, using practical examples to format commits and evolve changelogs over time with consistent semantic history tracking.

When should I use the revert commit type instead of fix in my conventional commit history?

Use the revert commit type in conventional commit history when undoing a previous commit, whereas fix should be used for patching bugs, ensuring accurate automated changelog categorization and release tracking.