本文最后更新于 1043 天前,其中的信息可能已经有所发展或是发生改变。
🐱commit message格式
<类型>[范围]: <标题>
[主体内容]
例如:fix(admin): k8sProxy反向代理路由修改
类型(必须)
用于说明git commit的类别,只允许使用下面的标识。
-
feat:新功能(feature)。
-
fix:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。
-
docs:文档(documentation)。
-
style:格式(不影响代码运行的变动)。
-
refactor:重构(即不是新增功能,也不是修改bug的代码变动)。
-
perf:优化相关,比如提升性能、体验。
-
test:增加测试。
-
chore:构建过程或辅助工具的变动。
-
revert:回滚到上一个版本。
-
merge:代码合并。
-
sync:同步主线或分支的Bug。
范围(可选)
- 用于说明 commit 影响的范围,例如项目包含多模块,admin、interface、task、job等
- 多个以
|
分割
标题(必须)
- 标题是commit目的的简短描述。
主体内容(可选)
- 用新的空行将“标题”和“主体内容”隔开,Git 会自动识别第一行为摘要。
- 主体内容是commit目的的详细描述,可以放一些备注、说明等。
注:提交信息应该尽可能准确的描述本次提交内容。