Commit

按 Conventional Commits 规范编写提交信息。在创建 git commit 时使用。

alibaba b45fa4f 1.3 KB Updated

File contents

Commit Skill

生成符合 Conventional Commits 规范的提交信息。

格式

type(scope): 动词+对象

{为什么需要这次改动,带来哪些用户/系统影响}

Fixes #{ISSUE_ID}

字段

  • typefeat | fix | docs | style | refactor | perf | test | chore | revert
  • scope:可选,文件/模块/子系统,如 apiuiauthdeps
  • subject:≤ 50 字符,祈使句,首字母小写,不加句号
  • body:每行 ≤ 72 字符,解释「做了什么」与「为什么做」
  • footer:可选,关联 Issue / PR / Breaking Change

步骤

  1. 读取 git diff 收集信息;若用户已提供上下文则跳过。
  2. 判断变更属于哪一类 type。
  3. 若改动跨多个 scope,使用最核心模块作为 scope。
  4. 提取「新增 / 修改 / 删除」的函数、类、接口名,写入 subject。
  5. 若存在破坏性变更,在 footer 加 BREAKING CHANGE: 说明。
  6. 先给出完整 commit 供用户确认,再询问是否执行 git commit

禁止行为

  • 不得使用 update codefix bugwip 等无意义描述。
  • 禁止 subject 或 body 行超过 72 字符。
  • 禁止把 issue 链接放在 subject 行。

alibaba/loongcollector/tree/main/skills/commit commit b45fa4fb35

Frequently asked questions

npx skillmds@latest add alibaba/commit