「Git提交规范」
前言
互联网开发过程中,团队合作是很重要的一环,而对于代码的提交规范是平时工作中最基本的交流。规范的提交同样有利于减少沟通成本。团队中其他成员通过git message就能直接获取到,这里修改了什么,做了哪些操作影响面是什么等等,一目了然。而目前应用比较广泛的是Angular规范。
规范
git commit -m “message”
其中message应该包含三个重要信息:<type>(<scope>):<subject>
也即是类型、范围、主题。
type作为必选参数,主要有如下参考:
表示此次提交的代码修改的类型,有可能是bugfix、test…
-
subject:简短的描述性内容,可以是中文、也可以是英文、但还是不太建议中英结合的方式。
-
scope:表示提交的代码的影响面,最好还是带上这个参数;可能是某个类、管理器(Manager)、控制器、视图(UI)等等。
-
fix:出现频率最高,没有之一😄,写的每一行都是bug。字段表示Bug修复,无论是代码review时发现还是测试部门提交的Bug,问题修复完毕使用此type提交。
-
merge:代码合并,当然最好是描述出从哪个分支合并到哪个分支。
-
docs:提交只涉及文档的修改。
-
test:增加相关测试,或者对现有的测试修改。
-
revert:回退到上一个版本,可以描述出回退的原因。
-
refactor:代码的重构,可以理解为比如对代码中if-else进行重构,减少这种代码,这里并不涉及新功能的增加,当然重构不代表性能的提升(可能是结构清晰)。
-
perf:代码优化,性能提升,或者用户体验提升。像时间复杂度从 O(n) 优化到 O(1) 这是明显的提升。
-
feat:也即是feature,代表新功能的增加。
示例
//修复bug
git commit -m "fix(MainActivity):吐司传入上下文修改"
//新增功能
git commit -m "feat(Manager):新增获取屏幕参数工具类"
//...