Angular 規(guī)范使用代碼 commit 的方式
概要說明：
Git每次提交代碼都要寫commit message(提交說明)，否則就不允許提交。但是, 一般來說，commit message應(yīng)該清晰明了，說明本次提交的目的，可就是有一些人寫了些亂七八糟的東西上來。目前社區(qū)有很多種commit message方案，其中Angular規(guī)范是目前使用最廣的寫法，比較合理和系統(tǒng)化，并且有配套的工具。前前端框架Angular.js采用的就是該規(guī)范。
1. 使用 Angular commit Standard 的作用
- 方便查看每次提交版本更新內(nèi)容: `git log <last tag> HEAD --pretty=format:%s`
- 方便的查找某個(gè)關(guān)鍵技術(shù)處在哪個(gè)版本: `git log <last release> HEAD --grep feature`
- 可以自動(dòng)生成 `CHANGELOG`
- 可讀性好，方便做 `code revieing`
- 方便 `git blame` 跟蹤工程歷史，追究模塊責(zé)任，提高代碼質(zhì)量
2. 提交格式
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
例如:
feat(route, controller, service): add users module
we add users entity for mutil method apis
- 其中
Header一行是必須的，Body和Footer是可選的。 - 建議提交的說明部分不一行要太長，影響單行顯示效果
3. 提交格式詳細(xì)說明
- Header: 只有一行，包括三個(gè)字段：
type（必需）、scope（可選）和subject（必需）。- type: 用于說明
commit的類別，只允許使用下面7個(gè)標(biāo)識(shí)。如果type為feat和fix，則該commit將肯定出現(xiàn)在CHANGELOG中。其他情況（docs、chore、style、refactor、test）由你決定，要不要放入CHANGELOG，建議不要。
feat：新功能（feature） fix：修補(bǔ)bug docs：文檔（documentation） style： 格式（不影響代碼運(yùn)行的變動(dòng)） refactor：重構(gòu)（即不是新增功能，也不是修改bug的代碼變動(dòng)） test：增加測(cè)試 chore：構(gòu)建過程或輔助工具的變動(dòng)- scope: 用于說明
commit影響的范圍，比如數(shù)據(jù)層、控制層、視圖層等等，如果你的修改影響了不止一個(gè)scope，可以使用*代替。。 - subject:
subject是commit目的的簡(jiǎn)短描述，不超過50個(gè)字符。 - 以動(dòng)詞開頭，使用第一人稱現(xiàn)在時(shí)，比如
change，而不是changed或changes - 第一個(gè)字母小寫
- 結(jié)尾不加句號(hào)（.）
- type: 用于說明
- Body: 對(duì)本次
commit的詳細(xì)描述，可以分成多行。下面有一個(gè)范例。- 使用第一人稱現(xiàn)在時(shí)，比如使用
change而不是changed或changes。 - 永遠(yuǎn)別忘了第2行是空行。
- 應(yīng)該說明代碼變動(dòng)的動(dòng)機(jī)，以及與以前行為的對(duì)比。
More detailed explanatory text, if necessary. Wrap it to about 72 characters or so. Further paragraphs come after blank lines. - Bullet points are okay, too - Use a hanging indent - 使用第一人稱現(xiàn)在時(shí)，比如使用
- Footer:
- 不兼容變動(dòng): 如果當(dāng)前代碼與上一個(gè)版本不兼容，則
Footer部分以BREAKING CHANGE開頭，后面是對(duì)變動(dòng)的描述、以及變動(dòng)理由和遷移方法。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. - 關(guān)閉
issue: 如果當(dāng)前commit針對(duì)某個(gè)issue，那么可以在Footer部分關(guān)閉這個(gè)issue。Closes #234 Closes #234，#231，#424
- 不兼容變動(dòng): 如果當(dāng)前代碼與上一個(gè)版本不兼容，則
4. 使用工具提交代碼
- 可以使用典型的
gitflow或通過使用CLI向?qū)?commitizen來添加提交消息格式。 - 安裝CLI工具并使其支持
Angular規(guī)范npm install -g commitizen commitizen init cz-conventional-changelog --save --save-exact - 后續(xù)所有的
git commit都用git cz代替。
5. 如何生成 CHANGELOG
- 如果你的所有
commit都符合Angular格式，那么發(fā)布新版本時(shí)，CHANGELOG就可以用conventional-changelog腳本自動(dòng)生成。 - 生成的文檔包括以下三個(gè)部分:
New features,Bug fixes,Breaking changes。 - 每個(gè)部分都會(huì)羅列相關(guān)的
commit，并且有指向這些commit的鏈接。生成的文檔允許手動(dòng)修改，所以發(fā)布前，你還可以添加其他內(nèi)容。 - 生成
CHANGELOG請(qǐng)依次執(zhí)行下面的命令npm install -g conventional-changelog cd my-project conventional-changelog -p angular -i CHANGELOG.md -w
6. 參考
7. 相關(guān)問題解答
-
妹妹：不用工具，我們團(tuán)隊(duì)手動(dòng)書寫的提交消息亂七八糟的怎么辦？
哥哥：那你裝個(gè)
Commitizen不行? 或者使用validate-commit-msg包校驗(yàn)提交是否符合規(guī)范，類似于pre-commit攔截。 -
妹妹：每次一個(gè)版本發(fā)布生成
CHANGELOG的命令好長，我記不??？哥哥：你可以把它寫進(jìn)
Ppackage.json文件的script中啊。像我這樣以后就只要運(yùn)行npm run changlog生成CHANGELOG:"changelog": "conventional-changelog -p angular -i CHANGELOG.md -w"。 -
妹妹：提問？
哥哥：生動(dòng)舉例的回答。
