通过 GIT 提交代码的时候,必须要写提交说明,否则就无法提交
如果我们所有人能够按照一套规范去写提交说明(Commit Message ),那我们阅读 Pull Request 的效率就会很高, 参考了 Github 上的开源项目及部分公司的提交规范,总结出以下规范。
规范是所有人默认的一套规定,并不是强制要求,以公司的规范为首要,如果有问题,请留言。。。
部分提交代码说明参考
Commit Message 的标准格式
Commit Message 的组成部分:Header、Body、Footer
[Issues][Module]<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
Header 介绍
Header 的组成:Issues、Module、type、scope、subject
① Issues(可选)
Issues 我们可以理解成我们平时的 需求单 或者 修改单 的单号,一般指的是社区使用人员提出的问题编号
② Module(可选)
当前的修改主要修改了项目中的哪个模块,此处的定义不是很严格
③ type(必须)
用于说明此次提交主要做了哪种类型的处理,主要有以下这些类型
type | 说明 |
---|
feat | 增加了新功能或者新的需求(A new feautre) | fix | 修复了 bug 或者问题(fix a bug) | improvement | 对当前功能的改进(An improvement to current feature) | docs | 对文档进行了修改或者增加 | style | 格式化的变动,不影响代码的逻辑 | refactor | 对当前的需求的实现方式进行重构,不影响期望的结果 | perf | 提高性能的修改 | test | 增加或修改测试用例 | build | 构建工具或外部依赖包的修改,比如更新依赖包的版本等 | ci | 持续集成的配置文件或脚本的修改 | chore | 杂项,其他不修改源代码或测试代码的修改 | revert | 撤销某次提交 |
④ scope(可选)
此次提交的代码影响的范围,比如数据层、控制层、视图层等等
⑤ subject(必须)
此次提交的简短的描述
Body 介绍
Body:可以省略
Body 是对 subject 的补充,可以多行
Footer 介绍
Footer:可以省略
主要是一些关联 issue 的操作
提交示例
示例一:完成新的需求,需求单号为 208757 ,该需求可以让用户的积分推送到 kafka 的主题中
[208757][point][feat]: push customer's point to kafka
示例二:修改一个 bug ,该 bug 产生在需求单 208756 中,对应的缺陷是 237405 ,该 bug 导致了部分数据丢失
[208756][user][fix]: fix bug which can make user's data lost
when user choose add address,some data will lost
或者
[208756][user][fix]: fix bug which can make user's data lost (
|