SuperAPI AI 工具集

conventional-commits

编程与开发

查看项目

更新于 10-16 05:44

技能介绍

用途:按 Conventional Commits 规范格式化所有提交信息,以支持自动生成变更日志、语义化版本控制和更清晰的提交历史。

格式结构:<type>[optional scope]: <description>,其后可选正文与脚注。

必要类型:feat(新功能,对应语义化版本的 MINOR)、fix(缺陷修复,对应 PATCH)。常见其它类型包括 docs、style、refactor、perf、test、build、ci、chore、revert。

范围:可选 scope 提供代码库相关上下文,如 feat(parser): add ability to parse arrays。

描述:紧跟在类型/范围后的冒号和空格之后;使用祈使语气;首字母不大写;结尾不加句号;保持简洁(通常 50–72 字符)。

正文:可选,需在描述后空一行,可多段,说明“做了什么”和“为什么”,而非“怎么做”。

破坏性变更:可用 ! 标记,如 feat!: 或 feat(api)!:;或使用 BREAKING CHANGE 脚注;也可两者同时使用。语义化版本对应关系为 fix 对应 PATCH,feat 对应 MINOR,BREAKING CHANGE 对应 MAJOR。

使用时机:所有 git 提交、提交信息生成、拉取请求合并提交,以及用户询问提交信息或 git 提交时。需避免的常见错误包括使用过去时或大写开头、描述过于含糊、冗余表述及结尾加句号。