该规范主要参考《谷歌的代码评审指南》
优势:
格式:
commit message 都包含三个部分:Header(必需)、Body(可选)、Footer(可选)
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
Header 部分只有一行,三个字段:type(必需)、scope(可选)、subject(必需)
type 用于说明commit的类别,只允许使用下面7个标识
scope 用户说明 commit 影响的范围,比如数据层、控制层、视图层等 subject 是 commit 目的的简短描述,不超过50个字符
body 部分是对本次 commit 的详细描述,可以分成多行 footer 部分只用于两种情况:1、不兼容变动;2、关闭issue
扩展:如果你使用 IDEA 进行编码,可以是使用
git commit template
插件来规范每次提交的 commit message 信息
格式化后的代码 message 为:
feat(App): 增减排序算法
查看不用情况下的排序算法的区别
BREAKING CHANGE: 排序算法与上一个版本不兼容
Closes #123123
checklist
通过团队内部轮流review来帮助团队成员对项目整体流程和代码的认知,通过一次一次review来提高每个成员对整个项目的大体流程、细节的熟悉程度,减少因为不熟悉代码导致的重复逻辑开发,减少写重复代码的概率。
通过审核别人的代码,也能发现一些自己的一些缺点,有则改之,无则加勉。