AgentSkillsCN

semantic-commits

撰写规范、可解析的提交信息(Conventional Commits)的指南。

SKILL.md
--- frontmatter
name: semantic-commits
description: Guide to writing standard, parseable commit messages (Conventional Commits).

Semantic Commits Skill

1. The Philosophy

We use Conventional Commits to generate changelogs and determine SemVer bumps automatically. A commit message has three parts: type(scope): description

2. Commit Types

Choose the correct type based on your change:

TypeMeaningSemVer Impact
featA new featureMINOR
fixA bug fixPATCH
docsDocumentation onlyPATCH
styleFormatting (white-space, etc)PATCH
refactorCode change that neither fixes a bug nor adds a featurePATCH
perfCode change that improves performancePATCH
testAdding missing tests or correcting existing testsPATCH
choreBuild process, aux tools, dependency updatesPATCH

3. Formatting Rules

  1. Scope (Optional): The component being changed (e.g., auth, orders, cli).
  2. Description: concise, imperative mood ("add" not "added").
  3. Body (Optional): Context, motivation, and references (breaking changes go here).

4. Examples

Feature:

text
feat(billing): add stripe webhook handler

Bug Fix:

text
fix(validation): allow international phone numbers

Breaking Change:

text
feat(api): remove legacy search endpoint

BREAKING CHANGE: The /api/search endpoint has been removed. Use /api/v2/search instead.