git 每次提交代碼都會有message說明本次commit的目的。
一. commint 介紹
命令
git commit -m "commit message" # 直接加描述
git commit # 編輯器描述
目前,社區(qū)有多種 Commit message 的寫法規(guī)范。本文介紹 Angular 規(guī)范(見下圖),這是目前使用最廣的寫法,比較合理和系統(tǒng)化,并且有配套的工具。下面分別做介紹

Commit message 的格式
每次提交,Commit message 都包括三個部分:Header,Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
type
type:用于說明 commit 的類別,只允許使用下面7個標(biāo)識。
- feat:新功能(feature)
- fix:修補bug
- docs:文檔(documentation)
- style: 格式(不影響代碼運行的變動)
- refactor:重構(gòu)(即不是新增功能,也不是修改bug的代碼變動)
- test:增加測試
- chore:構(gòu)建過程或輔助工具的變動
如果type為feat和fix,則該 commit 將肯定出現(xiàn)在 Change log 之中。其他情況(docs、chore、style、refactor、test)看實際情況決定,要不要放入 Change log,建議是不要。
scope
scope用于說明 commit 影響的范圍,比如數(shù)據(jù)層、控制層、視圖層等等,視項目不同而不同。
subject
subject是 commit 目的的簡短描述,不超過50個字符。
- 以動詞開頭,使用第一人稱現(xiàn)在時,比如change,而不是changed或changes
- 第一個字母小寫
- 結(jié)尾不加句號(.)
Body
Body 部分是對本次 commit 的詳細(xì)描述,可以分成多行
Footer
Footer 部分只用于兩種情況。
(1)不兼容變動
如果當(dāng)前代碼與上一個版本不兼容,則 Footer 部分以BREAKING CHANGE開頭,后面是對變動的描述、以及變動理由和遷移方法。
BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly useful for directives so there should be no code using it.
(2)關(guān)閉 Issue
如果當(dāng)前 commit 針對某個issue,那么可以在 Footer 部分關(guān)閉這個 issue 。
Closes #234
也可以一次關(guān)閉多個 issue 。
Closes #123, #245, #992
Revert
還有一種特殊情況,如果當(dāng)前 commit 用于撤銷以前的 commit,則必須以revert:開頭,后面跟著被撤銷 Commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的,必須寫成This reverts commit hash.,其中的hash是被撤銷 commit 的 SHA 標(biāo)識符。
二. Commitizen 工具
書寫合格 Commit message 的工具
安裝命令如下。
$ npm install -g commitizen
然后,在項目目錄里,運行下面的命令,使其支持 Angular 的 Commit message 格式。
$ commitizen init cz-conventional-changelog --save --save-exact
以后,凡是用到git commit命令,一律改為使用git cz。這時,就會出現(xiàn)選項,用來生成符合格式的 Commit message。
