关于提交信息相关的规范中,被最多提及的应该是 Angular 的 Commit Message Format:
<type>(<scope>): <short summary>
│ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
│ │
│ └─⫸ Commit Scope: animations|bazel|benchpress|common|compiler|compiler-cli|core|
│ elements|forms|http|language-service|localize|platform-browser|
│ platform-browser-dynamic|platform-server|router|service-worker|
│ upgrade|zone.js|packaging|changelog|docs-infra|migrations|
│ devtools
│
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
build
构建ci
持续集成docs
文档(documentation)feat
新功能(feature)fix
BUG 修复perf
性能优化refactor
重构test
测试代码
Vue 也有一个 Git Commit Message Convention
/^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types)(\(.+\))?: .{1,50}/
比 Angular 增加了:
polish
优化style
样式修改workflow
工作流改进-
chore
构建过程或辅助工具的变动 -
style: 格式(不影响代码运行的变动)
-
refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
- improvement: 改进
- types: 类型定义文件修改
-
chore:构建过程或辅助工具的变动
- build: 打包
- ci: 持续集成
-
其他
- revert: 撤销,版本回退
- wip: 开发中
参考
- Using Git Commit Message Templates to Write Better Commit Messages
https://gist.github.com/lisawolderiksen/a7b99d94c92c6671181611be1641c733 - git commit 提交信息规范入门(配合 vscode)
https://blog.csdn.net/weixin_40780243/article/details/108900691 - 技巧 - 如何写好一个 Git 提交信息及几种不同的规范
https://zhuanlan.zhihu.com/p/27501055 - Commit message 和 Change log 编写指南
https://ruanyifeng.com/blog/2016/01/commit_message_change_log.html