在我们向github仓库提交代码时,git commit
命令是不可缺少的。我们在commit时需要附带一些提交信息,否则将禁止提交。
我们一般都简短的写一下本次提交的内容,但是我们对于代码的提交是非常频繁的,时间一长,再回过头来看自己的提交记录,完全摸不着头脑。
所以git代码提交规范化是有大势所趋,将代码提交分类,让敲码生活更美好。
目前业界用的最多的就是Angular团队的规范,commit message主要格式如下:
<type>(<scope>):<subject>
<BlLANK_LINE>
<?body>
<BLANK_LINE>
<?footer>
主要有「header、body、fotter」三个部分,type是必须的,后两个可选。
header只有一行,包括三个字段,「type(必选)」、「scope(可选)」、「subject(可选)」。
「type」字段用于说明commit的类型:
当type为feat或fix时,该commit应该出现在Change log,其他类型的commit不应出现在Change log中。
「scope」字段用于说明commit影响的范围,如视图层、控制层等,不是必选。
「subject」字段是commit目的的简要描述,格式:
body部分是本次commit的详细描述,可以分成多行。注意点:
footer部分只用于两种情况:
Commitizen是一个规范git commit的工具,使用前需要使用命令npm i -g commitizen
安装使用。
平时也可以不使用工具,在提交时使用类似git commit -m 'type: subject'
的格式提交。