SuperAPI AI 工具集

git-commit

编程与开发

查看项目

更新于 10-15 21:11

技能介绍

用途:为所有 git 提交和 PR/MR 标题定义默认提交信息格式,即 Conventional Commits;当项目在 CLAUDE.md、AGENTS.md、贡献指南等中已定义自己的提交规范时,以项目规则为准。

主要能力与规则:类型为必填前缀,常见类型包括 feat、fix、docs、style、refactor、perf、test、build、ci、chore;scope 可选,多模块仓库建议使用,如 feat(auth): add OAuth2 flow;描述使用小写、祈使语气、不加句号,如 fix: handle null response;破坏性变更在类型或 scope 后加 !,如 feat(api)!: remove v1 endpoints;提交信息不得添加 Co-Authored-By 尾注;描述变更本身而非过程,如不要写“address review feedback”或“coderabbit round 2 fixes”,而应写具体改了什么。

使用方式:用 git commit -m "feat: add user profile page" 等命令按格式提交;PR/MR 标题遵循同一格式,因为 squash 合并会用标题作为提交信息。可通过 git remote get-url origin 判断远端并选择 CLI:包含 github.com 用 gh,命令与术语为 PR;包含 gitlab.com 或自托管 GitLab 用 glab,术语为 MR;无法判断时询问用户。示例:gh pr create --title "feat: add dark mode" --body "...",glab mr create --title "feat: add dark mode" --description "..."。

审查修复类提交同样只描述改了什么,触发原因(审查者、机器人、第几轮)留在 PR 讨论中,不进入提交信息;一轮审查可拆成多个不同类型的提交。

限制:不适用于项目已自定义提交规范的场景;正文仅在描述和 diff 无法承载信息(如破坏性变更细节、迁移步骤)时才添加,不要复述 diff。