跳到正文
cccskills
免费在 GitHub 公开

conventional-commits

Create, classify, validate, and explain commit messages using Conventional Commits v1.0.0, with repository-aware type, scope, footer, and breaking-change guidance. Use when drafting or reviewing a commit message.

中文简介正在准备中。当前显示原文说明。

实测评分 未实测

查看安装方法

包含的文件(1)

  • SKILL.md6.3 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Conventional Commits

Use this skill to draft or review one commit message. Apply Conventional Commits v1.0.0 first, then report repository-specific style concerns separately.

When to Use

Use this skill when you need to:

  • draft a commit message from a change description;
  • classify a change by its primary purpose;
  • review a proposed commit message;
  • explain a type, scope, footer, or breaking-change marker;
  • suggest a corrected message without inventing technical details.

Do not use this skill for commit-history intervals, churn metrics, architectural convergence, release automation, or changelog generation. Use git-history-interval-study for history analysis and adr-distillation for enduring architectural decisions.

Message Format

<type>[optional scope][!]: <description>

[optional body]

[optional footer(s)]

The header requires a type, the : separator, and a non-empty description. A scope is optional and normally names the affected area. A body and footers are optional and follow a blank line.

Examples:

feat(export): add GeoJSON output

fix(auth)!: reject expired sessions

docs: clarify installation steps

fix(parser): handle empty input

Refs: #123
Reviewed-by: Example User
Change-Id: Iabc123
BREAKING CHANGE: callers must pass an explicit format

Do not require a scope, body, or footer when the message is otherwise valid.

Default Type Taxonomy

Use the change's primary purpose. Recommend separate commits when independent changes can be separated.

TypeUse for
featA new user- or system-facing capability
fixIncorrect, unintended, or failing behavior
perfA performance or resource-use improvement
refactorBehavior-preserving restructuring
docsDocumentation-only changes
testTest-only changes
buildBuild tools, dependencies, or packaging
ciContinuous-integration or delivery configuration
styleNon-functional formatting or style
choreMaintenance not covered by a more specific type
revertReversal of an earlier commit

Conventional Commits gives normative meaning to feat and fix. The remaining types are an allowed project taxonomy and may be overridden by repository guidance.

When categories overlap, choose the primary purpose:

  • use perf when performance is the main objective, otherwise refactor;
  • use fix when correcting runtime behavior is the main objective, otherwise build for dependency or packaging work;
  • use ci for delivery automation and test for tests or test behavior;
  • use docs for documentation content and build or ci when documentation automation is the main change.

Breaking Changes

A breaking change may be marked in the header:

refactor(api)!: replace the response contract

or in a footer:

refactor(api): replace the response contract

BREAKING CHANGE: clients must use the new response fields

Both forms may be used together. Recognize BREAKING CHANGE: and BREAKING-CHANGE:. A breaking change may accompany any type.

Treat the breaking-change token as the uppercase special footer form. General type casing may be accepted by a standards-oriented review, but lowercase types remain the repository style recommendation.

Bodies and Footers

Use a body when context, motivation, or consequences need explanation. Use footers for issue references, acknowledgments, metadata, or breaking-change details.

Valid footer shapes include:

Token: value
Token #value

Ordinary footer tokens must not contain whitespace. Use a hyphen for multiword tokens, such as Reviewed-by. BREAKING CHANGE is the special exception.

Do not claim that Fixes, Refs, Closes, or other issue-reference tokens are required by Conventional Commits. Preserve repository-specific footer conventions when they exist.

Drafting Workflow

  1. Identify the change's primary purpose.
  2. Select the most specific applicable type.
  3. Add a useful scope when the affected area is known.
  4. Mark a breaking change with !, a breaking footer, or both.
  5. Write a concise description after : .
  6. Add a body or footer only when it adds necessary context.
  7. Ask for clarification instead of inventing technical details.

Prefer a single-sentence subject. Do not put orchestration, wave, or phase numbers in the subject; record those in planning artifacts instead.

Review Workflow

  1. Parse the type, optional scope, optional !, and description.
  2. Verify the type: description structure and exact colon-plus-space separator.
  3. Check blank-line separation before bodies and footers.
  4. Check footer token syntax.
  5. Identify breaking changes from either supported indicator.
  6. Apply the primary-purpose taxonomy.
  7. Check repository-specific types, scopes, casing, and footer conventions.
  8. Report concrete findings and a corrected message when useful.

Return this shape:

Status: Valid | Invalid | Valid with project-specific concerns

Findings:
- ...

Suggested message:

<suggested type>[optional scope][!]: <suggested description>

Use Invalid for malformed or incomplete Conventional Commit syntax. Use Valid with project-specific concerns when the standard is satisfied but local style or policy should be improved.

Repository Boundaries

  • git-history-interval-study owns commit-range analysis, churn, type distributions, and architectural convergence.
  • adr-distillation may use commit messages as evidence, but a message alone does not prove an enduring architectural decision.
  • plan-wave and wave-orchestration own planning state, task reports, dependencies, and execution metadata.
  • Repository-specific types and scopes take precedence as policy, but optional standard elements must not be made mandatory without explicit local guidance.

Reference: Conventional Commits v1.0.0.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Distills enduring architectural decisions and design rationale from wave orchestration plans or historical git changes into structured, tracked Architecture Decision Records (ADRs). Use pre-wave to resolve active architectural constraints or post-wave to record enduring decisions in docs/decisions/.

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

Create and maintain AGENTS.md files for project onboarding and grounding. Use when initialized in a new project, when project structure changes significantly, or when creating subfolder-level AGENTS.md files for complex monorepos.

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

Audit and update an arbitrary codebase to follow the Code.mil federal open-source licensing model (MIT with 17 U.S.C. Section 105 disclaimers and INTENT.md), including CRAN/R package DESCRIPTION setup.

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

Migrates ArcPy and ArcGIS Pro workflows to explicit, testable open-source Python geospatial workflows. Use when removing ArcPy dependencies, porting geoprocessing scripts, or documenting ArcGIS behavior that will not be migrated.

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

Adversarial tester and UX/documentation stress-tester that acts like a clumsy, literal-minded, or overwhelmed user to break systems, expose design flaws, and highlight confusing documentation. Use when the user asks to run "bull in a china shop" testing, stress-test an API/CLI/library/doc/workflow, find traps, test how a user might misuse a feature, or evaluate how documentation is interpreted.

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

caveman

免费

Ultra-compressed communication mode that cuts output tokens while keeping technical accuracy. Levels: lite, full, ultra and the wenyan variants. Use for /caveman, "caveman mode", "talk like caveman", "be brief" or "less tokens".

中文简介正在准备中。当前显示原文说明。

AndrewBrown-USDA/aigb-skills-usda72026年10月24日 更新

查看 AndrewBrown-USDA 的全部技能

报告此技能的问题