title: Git提交代码规范
tags:
- Git
abbrlink: '59e4634'
date: 2021-02-04 21:21:07
Git 每次提交代码,都是需要写 Commit message(提交说明),否则就不允许提交。
Commit message 的格式
(三部分):
必填
必需
必需
用于说明 commit
的类别,仅支持允许以下7个标识。
如果type为feat
和fix
,则该 commit 将肯定出现在 Change log 之中。其他情况(docs
、chore
、style
、refactor
、test
)由你决定,要不要放入 Change log,建议是不要。
效果如下:
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
例如在Angular
,可以是$location
, $browser
, $compile
, $rootScope
, ngHref
, ngClick
, ngView
等。
如果你的修改影响了不止一个scope
,你可以使用*
代替。
subject
是 commit 目的的简短描述,不超过50个字符。
其他注意事项:
Body 部分是对本次 commit 的详细描述,可以分成多行。
有两个注意点:
Footer 部分只用于以下两种情况:
Closes #234
还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。
revert: feat(pencil): add 'xxxxx' option` `This reverts commit docsxxx.
Body部分的格式是固定的,必须写成This reverts commit <hash>
.,
其中的hash是被撤销 commit 的 SHA 标识符。
那么它们都不会出现在 Change log 里面。
DO What You Want !
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。