📝

约定式提交类型

Conventional Commits 提交类型速查。

本地处理 · 不上传

加载工具中…

相关:commit · 提交规范 · feat · fix · git

约定式提交类型列出 feat、fix、docs 等提交类型的含义与使用场景。统一的提交格式让变更历史可以被自动解析。

使用步骤

  1. 按改动性质挑选 feat、fix、docs 等类型
  2. 需要时补上作用域,写在括号里
  3. 描述用祈使句,控制在一行内
  4. 破坏性变更要加感叹号或 BREAKING CHANGE 脚注

使用场景

  • 撰写规范的提交信息
  • 确认该用哪个类型
  • 理解他人的提交历史
  • 配置自动生成变更日志

小贴士

  • feat 与 fix 是最核心的两类,它们直接对应语义化版本的次版本号与修订号递增。
  • 提交信息中的破坏性变更标记(感叹号或 BREAKING CHANGE 脚注)会触发主版本号递增,务必正确标注。
  • 规范的价值在于可以自动生成变更日志与推断版本号,若团队不做这两件事,强推格式的收益会小很多。

常见问题

该用哪个类型?

新功能用 feat,修复 bug 用 fix,这两类会进入变更日志。文档改动用 docs,纯格式调整用 style,重构用 refactor,测试用 test,构建与工具链用 chore。

这套规范有什么实际好处?

提交历史变得机器可读,可以自动生成变更日志、自动推断下一个版本号。此外它也促使提交者思考「这次改动到底属于哪一类」,间接改善了提交的粒度。

破坏性变更怎么标?

在类型后加感叹号(feat!),或在提交正文后添加 BREAKING CHANGE 脚注说明。工具会据此把主版本号递增,这是使用者判断能否安全升级的关键信息。

约定式提交类型是免费的吗?

是。本站所有工具完全免费,无需注册登录、无广告干扰,打开即用。

使用约定式提交类型,我的数据安全吗?

安全。该工具在你的浏览器本地完成处理,输入内容不会上传到服务器,隐私更有保障。