一、為什么需要規(guī)范破花？
無(wú)規(guī)矩不成方圓谦趣，編程也一樣。
如果你有一個(gè)項(xiàng)目座每，從始至終都是自己寫前鹅，那么你想怎么寫都可以，沒(méi)有人可以干預(yù)你峭梳〗⒒妫可是如果在團(tuán)隊(duì)協(xié)作中，大家都張揚(yáng)個(gè)性葱椭，那么代碼將會(huì)是一團(tuán)糟捂寿，好好的項(xiàng)目就被糟踐了。不管是開發(fā)還是日后維護(hù)挫以，都將是災(zāi)難者蠕。
這時(shí)候，有人提出了何不統(tǒng)一標(biāo)準(zhǔn)掐松，大家都按照這個(gè)標(biāo)準(zhǔn)來(lái)踱侣。于是 ESLint，JSHint 等代碼工具如雨后春筍般涌現(xiàn)大磺，成為了項(xiàng)目構(gòu)建的必備良品抡句。
Git Commit 規(guī)范可能并沒(méi)有那么夸張，但如果你在版本回退的時(shí)候看到一大段糟心的 Commit杠愧，恐怕會(huì)懊惱不已吧待榔。所以，嚴(yán)格遵守規(guī)范，利人利己锐锣。
二腌闯、具體規(guī)則
先來(lái)看看公式：
<type>(<scope>): <subject>
type
用于說(shuō)明 commit 的類別，只允許使用下面7個(gè)標(biāo)識(shí)雕憔。
feat：新功能(feature)
fix：修補(bǔ)
bugdocs：文檔(documentation)
style： 格式(不影響代碼運(yùn)行的變動(dòng))
refactor：重構(gòu)(即不是新增功能姿骏，也不是修改bug的代碼變動(dòng))
test：增加測(cè)試
chore：構(gòu)建過(guò)程或輔助工具的變動(dòng)
scope
用于說(shuō)明 commit 影響的范圍，比如數(shù)據(jù)層斤彼、控制層分瘦、視圖層等等，視項(xiàng)目不同而不同琉苇。
subject
是 commit 目的的簡(jiǎn)短描述嘲玫，不超過(guò)50個(gè)字符。
以動(dòng)詞開頭并扇，使用第一人稱現(xiàn)在時(shí)去团，比如change，而不是changed或changes
第一個(gè)字母小寫
結(jié)尾不加句號(hào)(.)
三拜马、異常處理
我們先來(lái)看看這個(gè)異常提醒：
INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" !
jartto:fix bug
這里之所以報(bào)出這個(gè)警告渗勘，是因?yàn)槲业奶峤怀霈F(xiàn)了兩個(gè)問(wèn)題：
- 其一，使用了規(guī)范外的關(guān)鍵字;
- 其二俩莽，很細(xì)節(jié)的問(wèn)題旺坠，jartto：后少了空格;
這時(shí)候我才回憶起來(lái)，當(dāng)時(shí)提交一直失敗扮超，情急之下直接強(qiáng)制提交取刃，所以以后的提交都會(huì)抱出這個(gè)異常。大致意思就是：
你的之前的 Commit 不合格～你的之前的 Commit 不合格～你的之前的 Commit 不合格
這時(shí)候就很煩了出刷，我們只能去將之前的錯(cuò)誤修正璧疗，那么如何操作呢?
四、如何修改之前的 commit 信息馁龟？
其實(shí)并不復(fù)雜崩侠，我們只需要這樣做:
- 1、將當(dāng)前分支無(wú)關(guān)的工作狀態(tài)進(jìn)行暫存
git stash
- 2坷檩、 將 HEAD 移動(dòng)到需要修改的 commit 上
git rebase 9633cf0919^ --interactive
- 3却音、找到需要修改的 commit ,將首行的 pick 改成 edit
- 4、開始著手解決你的 bug
- 5矢炼、 git add 將改動(dòng)文件添加到暫存
- 6系瓢、 git commit –amend 追加改動(dòng)到提交
- 7、git rebase –continue 移動(dòng) HEAD 回最新的 commit
- 8句灌、恢復(fù)之前的工作狀態(tài)
git stash pop
大功告成夷陋，是不是想把整個(gè) Commit 都修改一遍，逃～
五、項(xiàng)目中使用
這時(shí)候問(wèn)題又來(lái)了骗绕，為什么我提交的時(shí)候會(huì)有警告藐窄，這個(gè)又是如何做到的呢?
這時(shí)候，我們需要一款 Node 插件 validate-commit-msg 來(lái)檢查項(xiàng)目中 Commit message 是否規(guī)范爹谭。
1.首先枷邪，安裝插件：
npm install --save-dev validate-commit-msg
2.使用方式一，建立 .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
}
3.使用方式二：寫入 package.json
{
"config": {
"validate-commit-msg": {
/* your config here */
}
}
}
4.可是我們?nèi)绻胱詣?dòng)使用 ghooks 鉤子函數(shù)呢诺凡？
{
…
"config": {
"ghooks": {
"pre-commit": "gulp lint",
"commit-msg": "validate-commit-msg",
"pre-push": "make test",
"post-merge": "npm install",
"post-rewrite": "npm install",
…
}
}
…
}
在 ghooks 中我們可以做很多事情，當(dāng)然不只是 validate-commit-msg 哦践惑。
更多細(xì)節(jié)請(qǐng)參考：validate-commit-msg
六腹泌、Commit 規(guī)范的作用
- 提供更多的信息，方便排查與回退;
- 過(guò)濾關(guān)鍵字尔觉，迅速定位;
- 方便生成文檔;
七凉袱、生成 Change log
正如上文提到的生成文檔，如果我們的提交都按照規(guī)范的話侦铜，那就很簡(jiǎn)單了专甩。生成的文檔包括以下三個(gè)部分：
New features
Bug fixes
Breaking changes.
每個(gè)部分都會(huì)羅列相關(guān)的 commit ，并且有指向這些 commit 的鏈接钉稍。當(dāng)然涤躲，生成的文檔允許手動(dòng)修改，所以發(fā)布前贡未，你還可以添加其他內(nèi)容种樱。
這里需要使用工具 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"
}
}
這樣嫩挤，使用起來(lái)就很簡(jiǎn)單了：
npm run changelog
到這里，我們所有的問(wèn)題都搞明白了消恍， Cheers～
八岂昭、總結(jié)
看完文章，你還會(huì)如此放蕩不羈嗎?你還會(huì)隨心所欲的編寫 Commit 嗎?你還會(huì)如此 git commit -m "hello world"提交嗎?
答案是否定的狠怨，因?yàn)槭褂昧算^子函數(shù)约啊，你沒(méi)有機(jī)會(huì)了，否則將是無(wú)窮無(wú)盡的恢復(fù) Commit取董。這倒可以養(yǎng)成良好的提交習(xí)慣棍苹。
===========我是華麗的分割線===========
更多知識(shí)：
點(diǎn)擊關(guān)注專題：嵌入式Linux&ARM
或?yàn)g覽器打開：http://www.reibang.com/c/42d33cadb1c1
或掃描二維碼：
文章參考微信公眾號(hào)[良許Linux]
