提醒！你可能会忽略的 Git 提交规范

1、为何须要规范？

无规矩不成方圆，编程也同样。

若是你有一个项目，从始至终都是本身写，那么你想怎么写均可以，没有人能够干预你。但是若是在团队协做中，你们都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不论是开发仍是往后维护，都将是灾难。

这时候，有人提出了何不统一标准，你们都按照这个标准来。因而 ESLint，JSHint 等代码工具如雨后春笋般涌现，成为了项目构建的必备良品。

Git Commit 规范可能并无那么夸张，但若是你在版本回退的时候看到一大段糟心的 Commit，恐怕会懊恼不已吧。因此，严格遵照规范，利人利己。

2、具体规则

先来看看公式：

<type>(<scope>): <subject>

• type

用于说明 commit 的类别，只容许使用下面7个标识。

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style： 格式（不影响代码运行的变更）
refactor：重构（即不是新增功能，也不是修改bug的代码变更）
test：增长测试
chore：构建过程或辅助工具的变更

• scope

用于说明 commit 影响的范围，好比数据层、控制层、视图层等等，视项目不一样而不一样。

• subject

是 commit 目的的简短描述，不超过50个字符。

以动词开头，使用第一人称如今时，好比change，而不是changed或changes

第一个字母小写

结尾不加句号(.)

3、异常处理

咱们先来看看这个异常提醒：

INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! jartto:fix bug 

这里之因此报出这个警告，是由于个人提交出现了两个问题：

其一，使用了规范外的关键字;

其二，很细节的问题，jartto：后少了空格;

这时候我才回忆起来，当时提交一直失败，情急之下直接强制提交，因此之后的提交都会抱出这个异常。大体意思就是：

你的以前的 Commit 不合格～你的以前的 Commit 不合格～你的以前的 Commit 不合格

这时候就很烦了，咱们只能去将以前的错误修正，那么如何操做呢?

4、如何修改以前的 commit 信息？

其实并不复杂，咱们只须要这样作:

一、将当前分支无关的工做状态进行暂存

git stash 

二、将 HEAD 移动到须要修改的 commit 上

git rebase 9633cf0919^ --interactive

三、找到须要修改的 commit ,将首行的 pick 改为 edit

四、开始着手解决你的 bug

五、 git add 将改动文件添加到暂存

六、 git commit –amend 追加改动到提交

七、git rebase –continue 移动 HEAD 回最新的 commit

八、恢复以前的工做状态

git stash pop

大功告成，是否是想把整个 Commit 都修改一遍，逃～

5、项目中使用

这时候问题又来了，为何我提交的时候会有警告，这个又是如何作到的呢?

这时候，咱们须要一款 Node 插件 validate-commit-msg 来检查项目中 Commit message 是否规范。

一、首先，安装插件：

npm install --save-dev validate-commit-msg 

二、使用方式一，创建 .vcmrc 文件：

{   
"types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"],   
"scope": {   
"required": false,   
"allowed": ["*"],   
"validate": false,   
"multiple": false  
  },   
"warnOnFail": false,   
"maxSubjectLength": 100,   
"subjectPattern": ".+",   
"subjectPatternErrorMsg": "subject does not match subject pattern!",   
"helpMessage": "",   
"autoFix": false  
}

三、使用方式二：写入 package.json

{   "config": {    
"validate-commit-msg": {      
/* your config here */    
}   
} 
}

四、但是咱们若是想自动使用 ghooks 钩子函数呢？

{   …   "config": {    
"ghooks": {       
"pre-commit": "gulp lint",       
"commit-msg": "validate-commit-msg",       
"pre-push": "make test",       
"post-merge": "npm install",       
"post-rewrite": "npm install", 
…     
}   
}   
… 
}

在 ghooks 中咱们能够作不少事情，固然不仅是 validate-commit-msg 哦。

更多细节请参考：https://github.com/convention...

6、Commit 规范的做用

• 一、提供更多的信息，方便排查与回退;
• 二、过滤关键字，迅速定位;
• 三、方便生成文档;

7、生成 Change log

正如上文提到的生成文档，若是咱们的提交都按照规范的话，那就很简单了。生成的文档包括如下三个部分：

• New features
• Bug fixes
• Breaking changes.

每一个部分都会罗列相关的 commit ，而且有指向这些 commit 的连接。固然，生成的文档容许手动修改，因此发布前，你还能够添加其余内容。

这里须要使用工具 Conventional Changelog 生成 Change log ：

npm install -g conventional-changelog 
cd jartto-domo 
conventional-changelog -p angular -i CHANGELOG.md -w

为了方便使用，能够将其写入 package.json 的 scripts 字段。

{   "scripts": {     
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"   
}
}

这样，使用起来就很简单了：

 npm run changelog

到这里，咱们全部的问题都搞明白了，🍻 Cheers～

8、总结

看完文章，你还会如此放荡不羁吗?你还会为所欲为的编写 Commit 吗?你还会如此 git commit -m "hello world"提交吗?

答案是否认的，由于使用了钩子函数，你没有机会了，不然将是无穷无尽的恢复 Commit。这倒能够养成良好的提交习惯~~

来自：Jartto's blog
连接： http://jartto.wang/2018/07/08...