SuperAPI AI 工具集

conventional-commits

编程与开发

查看项目

更新于 10-16 05:54

技能介绍

用途:该技能用于将 git 提交信息统一为 Conventional Commits 1.0.0 规范,适合提交前整理信息或在用户要求提交、创建 git commit 时使用。

主要能力:

  • 提交信息格式:<type>[可选 scope]: <description>,可选正文与脚注。
  • 类型参考:feat(新功能,MINOR)、fix(缺陷修复,PATCH)、docs、style、refactor、perf、test、build、ci、chore、revert。
  • 通过决策框架判断类型:新增功能用 feat,修复用 fix,仅文档用 docs,性能用 perf,重构不改行为用 refactor,仅格式用 style,测试用 test,构建/依赖用 build,CI/CD 用 ci,维护与工具用 chore。
  • 描述建议:首行不超过 50 字符,使用祈使语气,首字母不大写,结尾不加句号。
  • scope 建议保持一致,如 feat(auth):、fix(api):、docs(readme):。
  • 正文在需要解释时使用,说明原因与解决的问题,每行 72 字符换行。
  • 脚注支持 Fixes #123、Co-authored-by: Name <email>、BREAKING CHANGE: 描述、Refs: #456, #789。
  • 破坏性变更可用 !(如 feat!: 或 feat(api)!:)或 BREAKING CHANGE: 脚注标记。

使用方式:检查暂存区 git diff --cached --stat;未暂存先 git add;查看 git diff --cached 与 git log --oneline -5;判断类型并撰写信息;提交时用单引号避免 ! 被 shell 转义,如 git commit -m 'feat!: add new authentication flow'。多行信息用 HEREDOC,命令保持原样。提交后可用 git log -1 核对。

限制:资料未提供安装命令、价格、平台支持范围及自动化集成细节。