Git代码提交规范
共 1478字,需浏览 3分钟
·
2021-02-06 00:36
Git 代码规范
Git 每次提交代码,都是需要写 Commit message(提交说明),否则就不允许提交。
Commit message 的格式
(三部分):
Heaher -----
必填
type ---
必需
scope --- 可选
subject ---
必需
Body ---- 可省略
Footer ---- 可省略
Type说明
用于说明 commit
的类别,仅支持允许以下7个标识。
feat:新功能 (feature)
fix: 修补bug
docs:文档(documentation)
style:格式(不影响代码运行的变动)
refactor:重构 (既不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程和辅助工具的变动注释
如果type为feat
和fix
,则该 commit 将肯定出现在 Change log 之中。其他情况(docs
、chore
、style
、refactor
、test
)由你决定,要不要放入 Change log,建议是不要。
效果如下:
Scope
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
例如在Angular
,可以是$location
, $browser
, $compile
, $rootScope
, ngHref
, ngClick
, ngView
等。
如果你的修改影响了不止一个scope
,你可以使用*
代替。
subject
subject
是 commit 目的的简短描述,不超过50个字符。
其他注意事项:
以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)
Body
Body 部分是对本次 commit 的详细描述,可以分成多行。
有两个注意点:
使用第一人称现在时,比如使用change而不是changed或changes。
永远别忘了第2行是空行
应该说明代码变动的动机,以及与以前行为的对比。
Footer
Footer 部分只用于以下两种情况:
不兼容变动
如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法
关闭 Issue
如果当前 commit 针对某个issue,那么可以在 Footer 部分关闭这个 issue 。
Closes #234
Revert
还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'xxxxx' option` `This reverts commit docsxxx.
Body部分的格式是固定的,必须写成This reverts commit
.,
其中的hash是被撤销 commit 的 SHA 标识符。
如果当前 commit 与被撤销的 commit,在同一个发布(release)里面,
那么它们都不会出现在 Change log 里面。
如果两者在不同的发布,那么当前 commit,会出现在 Change log 的Reverts小标题下面。
DO What You Want !