一、為什么需要標(biāo)準(zhǔn)化的commit message
先來(lái)看兩張圖，一張來(lái)自國(guó)際知名項(xiàng)目，一張是國(guó)內(nèi)某知名項(xiàng)目冕臭。
國(guó)際知名項(xiàng)目AngularJS
國(guó)內(nèi)知名項(xiàng)目MingGeJS
從上面兩張圖中，我想你已經(jīng)能看出一些端倪來(lái)了吧燕锥，相較而言哪種更加能促進(jìn)開(kāi)發(fā)不言自明辜贵。當(dāng)然，我舉這個(gè)國(guó)內(nèi)知名項(xiàng)目比較極端归形，不過(guò)整體而言都普遍存在Commit Message比較隨意的現(xiàn)象托慨。
Commit規(guī)范
順著思路，這一步應(yīng)該給方案了暇榴，方案就是上圖AngularJS項(xiàng)目中用到的Git Commit Guidelines厚棵。
Commit Message 格式
<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>
上面是一次Commit后Message格式規(guī)范蕉世，分成標(biāo)題，內(nèi)容詳情婆硬，結(jié)尾三個(gè)部分讨彼，各有各的用處，沒(méi)有多余項(xiàng)柿祈。
頭部即首行，是可以直接在頁(yè)面中預(yù)覽的部分哩至，入上面圖中所示躏嚎，一共有三個(gè)部分<type>，<scope>菩貌，<subject>卢佣，含義分別如下
- feat：新功能（feature）
- fix：修補(bǔ)bug
- docs：文檔（documentation）
- style： 格式（不影響代碼運(yùn)行的變動(dòng)）
- refactor：重構(gòu)（即不是新增功能，也不是修改bug的代碼變動(dòng)）
- test：增加測(cè)試
- chore：構(gòu)建過(guò)程或輔助工具的變動(dòng)
Type
feat：新功能（feature）
fix：修補(bǔ)bug
docs：文檔（documentation）
style： 格式（不影響代碼運(yùn)行的變動(dòng)）
refactor：重構(gòu)（即不是新增功能箭阶，也不是修改bug的代碼變動(dòng)）
test：增加測(cè)試
chore：構(gòu)建過(guò)程或輔助工具的變動(dòng)
Scope
用來(lái)說(shuō)明本次Commit影響的范圍虚茶，即簡(jiǎn)要說(shuō)明修改會(huì)涉及的部分。這個(gè)本來(lái)是選填項(xiàng)仇参，但從AngularJS實(shí)際項(xiàng)目中可以看出基本上也成了必填項(xiàng)了嘹叫。
Subject
用來(lái)簡(jiǎn)要描述本次改動(dòng)，概述就好了诈乒，因?yàn)楹竺孢€會(huì)在Body里給出具體信息罩扇。并且最好遵循下面三條:
以動(dòng)詞開(kāi)頭，使用第一人稱(chēng)現(xiàn)在時(shí)怕磨，比如change喂饥，而不是changed或changes
首字母不要大寫(xiě)
結(jié)尾不用句號(hào)(.)
Body
<body>里的內(nèi)容是對(duì)上面subject<subject style="margin: 0px; padding: 0px; max-width: 100%; box-sizing: border-box !important; word-wrap: break-word !important;">里內(nèi)容的展開(kāi)，在此做更加詳盡的描述肠鲫，內(nèi)容里應(yīng)該包含修改動(dòng)機(jī)和修改前后的對(duì)比员帮。</subject>
Footer
footer里的主要放置不兼容變更和Issue關(guān)閉的信息，參考下面兩個(gè)例子
Revert
此外如果需要撤銷(xiāo)之前的Commit导饲，那么本次Commit Message中必須以revert：開(kāi)頭捞高，后面緊跟前面描述的Header部分，格式不變帜消。并且棠枉，Body部分的格式也是固定的，必須要記錄撤銷(xiāo)前Commit的SHA值泡挺。
實(shí)踐利器
上面就是AngularJS目前的Commit規(guī)范辈讶，相信第一次接觸的話不免會(huì)有些頭大，這時(shí)如果有什么能Step by Step的提醒或者可視化的演示就好了娄猫。OK贱除，你來(lái)對(duì)地兒了生闲，現(xiàn)在就來(lái)說(shuō)說(shuō)如何把規(guī)范變?yōu)榭蓤?zhí)行的具體步驟！
二月幌、工欲善其事碍讯，必先利其器 - Commitizen
大量的代碼提交，必然會(huì)產(chǎn)生大量的commit log扯躺，而每一次commit是階段性的Ending捉兴，應(yīng)記錄著這一階段所完成的事以及關(guān)注點(diǎn)，盡可能詳細(xì)具體录语；且提供更多的歷史信息倍啥，方便快速瀏覽；可以過(guò)濾某些commit（比如文檔改動(dòng)）澎埠，便于快速查找信息虽缕；可以直接從commit生成Change log。所以log的格式就是關(guān)鍵所在蒲稳，而Commitizen可以完美的解決這些問(wèn)題氮趋。
Commitizen是什么？
是一個(gè)格式化commit message的工具江耀。它的安裝需要NPM的支持剩胁，NPM是Node.js的包管理工具，所以首先安裝node.js决记，下載對(duì)應(yīng)系統(tǒng)的包摧冀，安裝即可。
命令安裝Node.js：
brew install node
Commitizen安裝
npm install -g commitizen
安裝changelog系宫，是生成changelog的工具
npm install -g conventional-changelog
npm install -g conventional-changelog-cli
執(zhí)行
npm ls -g -depth=0
檢驗(yàn)上面兩個(gè)工具是否安裝成功索昂，得到結(jié)果如下，表示成功：
/usr/local/lib
├── commitizen@2.9.6
├── conventional-changelog@1.1.7
├── conventional-changelog-cli@1.3.5
└── npm@5.5.1
然后扩借，運(yùn)行下面命令椒惨，使其支持Angular的Commit message格式。
commitizen init cz-conventional-changelog --save --save-exact
但是注意潮罪，因?yàn)閏ommitizen工具是基于Node.js的康谆，而我們iOS項(xiàng)目工程目錄下是沒(méi)有package.json文件，所以會(huì)報(bào)錯(cuò)：
npm WARN saveError ENOENT: no such file or directory, open '/Users/Elite/package.json'
npm WARN enoent ENOENT: no such file or directory, open '/Users/Elite/package.json'
對(duì)于此種錯(cuò)誤嫉到，創(chuàng)建一個(gè)空的package.json文件沃暗，然后進(jìn)入到項(xiàng)目目錄，執(zhí)行
npm init --yes
會(huì)生成項(xiàng)目對(duì)應(yīng)項(xiàng)目的package.json何恶，將項(xiàng)目目錄下產(chǎn)生的package.json的內(nèi)容寫(xiě)入到自己建的package.json（/User/Elite/package.json）中孽锥，如果有多個(gè)項(xiàng)目，將各項(xiàng)目生成的package.json內(nèi)容寫(xiě)入到package.json中，下面是我的配置（/User/Elite/package.json）：
[{
"name": "salary",
"version": "1.0.0",
"description": "> v1.0 涵蓋所有老師（非中教）的基本工資惜辑、獎(jiǎng)勵(lì)工資唬涧、懲罰工資。",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git@***.***.com:erp/salary.git"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"cz-conventional-changelog": "^2.1.0"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"dependencies": {}
},
{
"name": "ats",
"version": "1.0.0",
"description": "composer.json composer配置 vendor 第三方類(lèi)庫(kù)",
"main": "index.js",
"directories": {
"test": "tests"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git@***.***.com:ats/ats.git"
},
"keywords": [],
"author": "",
"license": "ISC"
}]
然后進(jìn)入到你要操作的項(xiàng)目目錄盛撑，執(zhí)行
conventional-changelog -p angular -i CHANGELOG.md -s
此時(shí)項(xiàng)目中多了CHANGELOG.md文件碎节，表示生成 Change log成功了。以后抵卫，凡是用到git commit 命令的時(shí)候統(tǒng)一改為git cz,然后就會(huì)出現(xiàn)選項(xiàng)狮荔，生成符合格式的Commit Message。實(shí)例如下：
? Select the type of change that you're committing: (Use arrow keys)
? feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
然后按操作執(zhí)行介粘，即可產(chǎn)生change log轴合。如果最后產(chǎn)生一個(gè)這樣的錯(cuò)誤：
Error: Could not resolve /Users/Elite/web/node_modules/cz-conventional-changelog.
Cannot find module '/Users/Elite/web/node_modules/cz-conventional-changelog'
只需做個(gè)軟連接即可：
ln -s /Users/Elite/node_modules /Users/Elite/web/node_modules
使用
在代碼更改后，提交commit message的時(shí)候碗短，不再使用git commit -m方法，而是git cz题涨，將會(huì)出現(xiàn)交互式選項(xiàng)偎谁，讓你選擇或者輸入信息，給你一個(gè)完善的commit message纲堵。示例動(dòng)圖：
OK巡雨。
