SuperAPI AI 工具集

chinese-commit-conventions

编程与开发

查看项目

更新于 10-15 08:33

技能介绍

本技能提供一套面向中文团队的 Git 提交规范参考,覆盖规范定义、提交模板、工具链配置与落地流程。

一、用途 帮助团队统一中文 commit message 与 changelog 的写法,并借助工具链使规范可执行、可检查。

二、主要能力

  1. Conventional Commits 中文适配:定义 feat、fix、docs、style、refactor、perf、test、chore、ci、revert 十种类型及中文说明与示例场景;原则为 type 保留英文关键字,scope 与 description 使用中文,body 使用中文完整描述。
  2. 中文 commit message 模板:格式为 <type>(<scope>): <subject> 加 body、footer,并提供完整示例。
  3. Subject 行规范:type 必填、scope 选填(中文模块名)、description 必填且不超过 50 字符,使用动宾短语、不加句号,并给出正反示例。
  4. Body 编写规范:说明改动背景原因、技术方案、影响范围,每行不超过 72 字符(中文约 36 汉字),正文与标题间空一行,附 Body 模板。
  5. Breaking Changes 标注:支持 footer 标注与 type 后加感叹号两种格式,并给出团队约定(数据库表结构、公共 API、配置文件变更须标注)。
  6. Issue 关联:给出 GitHub、Gitee、Coding 及多平台通用写法。
  7. Changelog 自动生成:安装 conventional-changelog-cli 与 conventional-changelog-conventionalcommits,配置 package.json 脚本与 .versionrc.js 中文配置(含 types、section、commitUrlFormat、compareUrlFormat)。
  8. commitlint 中文配置:安装 @commitlint/cli 与 @commitlint/config-conventional,提供 commitlint.config.js,含 type-enum、type-case、subject-max-length、关闭 subject-case、放宽 header-max-length 等规则及中文 prompt 提示语。
  9. husky + lint-staged 集成:安装初始化 husky、lint-staged,配置 commit-msg 与 pre-commit 钩子及 lint-staged 规则;可选引入 commitizen 与 cz-conventional-changelog 实现交互式提交,运行 npm run commit。
  10. 团队规范检查清单:提交前自查项与团队落地步骤(工具链配置、模板共享、团队培训、Code Review、持续迭代),以及常见问题解答(中英混排空格、scope 语言选择、多人协作一致性)。

三、使用方式 按文档给出的安装命令与配置文件内容配置工具链,提交前参照检查清单自查;仅在用户显式调用 /chinese-commit-conventions 时启用本技能。

四、适用场景 中文开发团队统一 Git 提交信息与 changelog 生成流程,适用于需要规范 commit lint、自动化校验与发布日志的项目。

五、限制 本文档未提供具体产品版本、价格、收费、性能效果或平台支持的完整信息;实际使用需按项目环境自行验证配置。