Commit message 的格式
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
1. Header
Header部分只有一行赋朦,包括三個字段:type(必需)、scope(可選)和subject(必需)李破。
1.1 type
type用于說明commit 的類別宠哄,只允許使用下面12個標(biāo)識。
- feat:新功能(feature)
- fix:修補bug
- improvement: An improvement to a current feature
- docs:文檔(documentation)
- style: 格式(不影響代碼運行的變動)
- refactor:重構(gòu)(即不是新增功能嗤攻,也不是修改bug的代碼變動)
- perf: A code change that improves performance
- test:增加測試
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- chore: Other changes that don't modify src or test files
- revert: Reverts a previous commit
1.2 scope
scope用于說明 commit 影響的范圍毛嫉,比如數(shù)據(jù)層、控制層妇菱、視圖層等等承粤,視項目不同而不同。
1.3 subject
subject是 commit 目的的簡短描述闯团,不超過50個字符密任。
以動詞開頭,使用第一人稱現(xiàn)在時偷俭,比如change浪讳,而不是changed或changes
第一個字母小寫
結(jié)尾不加句號(.)
1.4 Body
Body 部分是對本次 commit 的詳細描述,可以分成多行涌萤。 有兩個注意點:
使用第一人稱現(xiàn)在時淹遵,比如使用change而不是changed或changes。
應(yīng)該說明代碼變動的動機负溪,以及與以前行為的對比透揣。
1.5 Footer
Footer 部分只用于兩種情況:
- 不兼容變動
如果當(dāng)前代碼與上一個版本不兼容,則 Footer 部分以BREAKING CHANGE開頭川抡,后面是對變動的描述辐真、以及變動理由和遷移方法。
- 關(guān)閉Issue
如果當(dāng)前commit針對某個issue崖堤,那么可以在Footer部分關(guān)閉這個issue 侍咱。
Closes #234
也可以一次關(guān)閉多個issue:
sCloses #123, #245, #992
工具
1. Commitizen
npm install -g commitizen
然后,在項目目錄里密幔,運行下面的命令楔脯,使其支持 Angular 的 Commit message 格式。
commitizen init cz-conventional-changelog --save --save-exact
以后胯甩,凡是用到git commit命令昧廷,一律改為使用git cz堪嫂。這時,就會出現(xiàn)選項木柬,用來生成符合格式的 Commit message皆串。
2. validate-commit-msg
npm install -g validate-commit-msg
3. husky
npm install -g husky
添加配置到package.json, 如果沒有此文件,在工程目錄執(zhí)行命令
npm init
{
"husky": {
"hooks": {
"commit-msg": "validate-commit-msg"
}
}
}