skills.rest
klen
klenCOMMUNITY
Explore all skills by this author →
Website𝕏@hornedsGitHub

conventional-commit

Structure commit messages according to the Conventional Commits specification.

5|Updated Oct 17, 2011
Search Tags:#git#changelog#code review#version control#commit#conventional commits
One-click install
npx skills add https://github.com/klen/dotfiles --skill conventional-commit-klen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/klen/dotfiles/tree/main/.config/opencode/skills/conventional-commit
Command: npx skills add https://github.com/klen/dotfiles --skill conventional-commit-klen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the challenge of inconsistent and unclear commit messages, which can lead to a messy and unmanageable project history.

Core Features & Use Cases

  • Structured Commit Messages: Enforces the Conventional Commits specification for clear, machine-readable commit history.
  • Improved Collaboration: Facilitates better understanding of code changes within a team.
  • Automated Changelogs: Enables automated generation of changelogs and version management.
  • Use Case: Before committing code, use this Skill to ensure your commit message follows the feat: add new functionality format, including a descriptive body explaining the 'why' and 'what' of the change.

Quick Start

Draft a commit message for a new feature by following the specified format.

Frequently Asked Questions about conventional-commit

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

FAQPage Schema
How do I write conventional commit messages for git?▼

Standardized commit messages follow the Conventional Commits specification, ensuring a clear and machine-readable history. This standardization automates changelog generation, facilitates version control, and improves code review processes for developers and teams.

What is the conventional commits format for automating changelogs?▼

Conventional commits format structures messages with type, scope, description, body, and footers for breaking changes and issue tracking. This machine-readable format enables automated changelog generation and version management for developers and teams.

How do I format a breaking change in a conventional commit?▼

You format a breaking change by including defined footers in your conventional commit message structure. This ensures the breaking change is machine-readable and properly tracked during code review and version control.

Why use conventional commits for code review processes?▼

Conventional commits improve code review processes by enforcing a clear and consistent commit message structure. This standardization facilitates better team collaboration and understanding of code changes within a project.

Does this conventional commit skill support issue tracking footers?▼

Yes, the conventional commit specification supports issue tracking by defining specific footers for breaking changes and issue tracking within the commit message. This maintains project integrity and a machine-readable commit history.

Related Skills

Explore More Software Engineering Skills→
KibertumKibertum
16

commit

Analyze diffs and generate conventional git commit messages with pre-commit checks.

Official
Intermediate
Paxeer-NetworkPaxeer-Network
3

writing-git-commits

I'm not able to help with that request, but I can point you to some helpful information about it.

Official
Intermediate
armanzeroeightarmanzeroeight
29

commit-message-generator

Generates commit messages from git diff output with customizable Type and Scope options.

Community
Basic
lukevellalukevella
5.2k

devmoji

Enforce emoji-prefixed commit messages in Git workflows.

Community
Intermediate