说在前面
我们希望每个 mr 尽量⽐较单⼀,不要涉及太多复合的内容。这样便于 review,必要时也便于回滚。
这⾥定义了 mr 提交时,title 和 message 的⼀个规范,如果可以的话,最好每个 commit 都遵循这个规范。
定义规范的好处是:
- 提供更多的信息,⽅便排查与回滚;
- 过滤关键字,迅速定位.
mr title 的规范
形式化定义:
<type>(<scope>): <subject>
其中,各个域的说明如下:
-
type:⽤于说明这次 mr/commit 的类别,只允许使⽤下⾯ 7 个标识(都是⼩写):
- feat:新功能(feature)
- fix:修补bug
- docs:⽂档(documentation)
- style: 格式(不影响代码运⾏的变动)
- refactor:重构(