git commit 規(guī)范指南

前言

Git 每次提交代碼缸剪,都要寫 Commit message(提交說(shuō)明)策添,否則就不允許提交材部。但是,一般來(lái)說(shuō)唯竹,commit message 應(yīng)該清晰明了乐导,說(shuō)明本次提交的目的。

不過(guò)話說(shuō)回來(lái)浸颓,作為最具個(gè)人創(chuàng)造力和最會(huì)利用工具的物種——程序猿物臂,最好是能有規(guī)范和工具的約束。否者的話产上,你可能看到以下的commit message

1.png

目前棵磷,社區(qū)有多種 Commit message 的寫法規(guī)范。本文介紹Angular 規(guī)范是目前使用最廣的寫法晋涣,比較合理和系統(tǒng)化仪媒,并且有配套的工具。前前端框架Angular.js采用的就是該規(guī)范谢鹊。如下圖:

2.png

Commit message 的作用

提供更多的歷史信息算吩,方便快速瀏覽留凭。

比如,下面的命令顯示上次發(fā)布后的變動(dòng)偎巢,每個(gè)commit占據(jù)一行蔼夜。你只看行首,就知道某次 commit 的目的压昼。

$ git log <last tag> HEAD --pretty=format:%s
3.png

可以過(guò)濾某些commit(比如文檔改動(dòng))求冷,便于快速查找信息

$ git log <last release> HEAD --grep feature

可以直接從commit生成Change log。

Change Log 是發(fā)布新版本時(shí)巢音,用來(lái)說(shuō)明與上一個(gè)版本差異的文檔,詳見后文尽超。

4.png

其他優(yōu)點(diǎn)

  • 可讀性好官撼,清晰,不必深入看代碼即可了解當(dāng)前commit的作用似谁。

  • 為 Code Reviewing做準(zhǔn)備

  • 方便跟蹤工程歷史

  • 讓其他的開發(fā)者在運(yùn)行 git blame 的時(shí)候想跪謝

  • 提高項(xiàng)目的整體質(zhì)量傲绣,提高個(gè)人工程素質(zhì)

Commit message 的格式

每次提交,Commit message 都包括三個(gè)部分:header巩踏,body 和 footer秃诵。

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中,header 是必需的塞琼,body 和 footer 可以省略菠净。
不管是哪一個(gè)部分,任何一行都不得超過(guò)72個(gè)字符(或100個(gè)字符)彪杉。這是為了避免自動(dòng)換行影響美觀毅往。

Header

Header部分只有一行,包括三個(gè)字段:type(必需)派近、scope(可選)和subject(必需)攀唯。

type

用于說(shuō)明 commit 的類別,只允許使用下面7個(gè)標(biāo)識(shí)渴丸。

  • 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為featfix,則該 commit 將肯定出現(xiàn)在 Change log 之中谱轨。其他情況(docs戒幔、chorestyle土童、refactor溪食、test)由你決定,要不要放入 Change log娜扇,建議是不要错沃。

scope

scope用于說(shuō)明 commit 影響的范圍栅组,比如數(shù)據(jù)層、控制層枢析、視圖層等等玉掸,視項(xiàng)目不同而不同。

例如在Angular醒叁,可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等司浪。

如果你的修改影響了不止一個(gè)scope,你可以使用*代替把沼。

subject

subject是 commit 目的的簡(jiǎn)短描述啊易,不超過(guò)50個(gè)字符。

其他注意事項(xiàng):

  • 以動(dòng)詞開頭饮睬,使用第一人稱現(xiàn)在時(shí)租谈,比如change,而不是changed或changes

  • 第一個(gè)字母小寫

  • 結(jié)尾不加句號(hào)(.)

Body

Body 部分是對(duì)本次 commit 的詳細(xì)描述捆愁,可以分成多行割去。下面是一個(gè)范例。

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

有兩個(gè)注意點(diǎn):

  • 使用第一人稱現(xiàn)在時(shí)昼丑,比如使用change而不是changed或changes呻逆。

  • 永遠(yuǎn)別忘了第2行是空行

  • 應(yīng)該說(shuō)明代碼變動(dòng)的動(dòng)機(jī),以及與以前行為的對(duì)比菩帝。

Footer

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

Revert

還有一種特殊情況州袒,如果當(dāng)前 commit 用于撤銷以前的 commit,則必須以revert:開頭弓候,后面跟著被撤銷 Commit 的 Header郎哭。

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的,必須寫成This reverts commit &lt;hash>.菇存,其中的hash是被撤銷 commit 的 SHA 標(biāo)識(shí)符夸研。

如果當(dāng)前 commit 與被撤銷的 commit,在同一個(gè)發(fā)布(release)里面依鸥,那么它們都不會(huì)出現(xiàn)在 Change log 里面亥至。如果兩者在不同的發(fā)布,那么當(dāng)前 commit,會(huì)出現(xiàn)在 Change log 的Reverts小標(biāo)題下面姐扮。

Commitizen

可以使用典型的git工作流程或通過(guò)使用CLI向?qū)?a target="_blank" rel="nofollow">Commitizen來(lái)添加提交消息格式絮供。

安裝

npm install -g commitizen

然后,在項(xiàng)目目錄里茶敏,運(yùn)行下面的命令壤靶,使其支持 Angular 的 Commit message 格式。

commitizen init cz-conventional-changelog --save --save-exact

以后惊搏,凡是用到git commit命令贮乳,一律改為使用git cz。這時(shí)恬惯,就會(huì)出現(xiàn)選項(xiàng)向拆,用來(lái)生成符合格式的 Commit message。

5.png

validate-commit-msg

validate-commit-msg 用于檢查項(xiàng)目的 Commit message 是否符合Angular規(guī)范酪耳。

該包提供了使用githooks來(lái)校驗(yàn)commit message的一些二進(jìn)制文件浓恳。在這里,我推薦使用husky葡兑,只需要添加"commitmsg": "validate-commit-msg"到你的package.json中的nam scripts即可.

當(dāng)然奖蔓,你還可以通過(guò)定義配置文件.vcmrc來(lái)自定義校驗(yàn)格式赞草。詳細(xì)使用請(qǐng)見文檔 validate-commit-msg

生成 Change log

如果你的所有 Commit 都符合 Angular 格式讹堤,那么發(fā)布新版本時(shí), Change log 就可以用腳本自動(dòng)生成厨疙。生成的文檔包括以下三個(gè)部分:

  • New features

  • Bug fixes

  • Breaking changes.

每個(gè)部分都會(huì)羅列相關(guān)的 commit 洲守,并且有指向這些 commit 的鏈接。當(dāng)然沾凄,生成的文檔允許手動(dòng)修改梗醇,所以發(fā)布前,你還可以添加其他內(nèi)容撒蟀。

conventional-changelog 就是生成 Change log 的工具叙谨,運(yùn)行下面的命令即可。

$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w

參考文章

Commit message 和 Change log 編寫指南
Angular.js Git Commit Guidelines


原文:https://segmentfault.com/a/1190000009048911

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末保屯,一起剝皮案震驚了整個(gè)濱河市手负,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌姑尺,老刑警劉巖竟终,帶你破解...
    沈念sama閱讀 206,214評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異切蟋,居然都是意外死亡统捶,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,307評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)喘鸟,“玉大人匆绣,你說(shuō)我怎么就攤上這事∶允兀” “怎么了犬绒?”我有些...
    開封第一講書人閱讀 152,543評(píng)論 0 341
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)兑凿。 經(jīng)常有香客問(wèn)我凯力,道長(zhǎng),這世上最難降的妖魔是什么礼华? 我笑而不...
    開封第一講書人閱讀 55,221評(píng)論 1 279
  • 正文 為了忘掉前任咐鹤,我火速辦了婚禮,結(jié)果婚禮上圣絮,老公的妹妹穿的比我還像新娘祈惶。我一直安慰自己,他們只是感情好扮匠,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,224評(píng)論 5 371
  • 文/花漫 我一把揭開白布捧请。 她就那樣靜靜地躺著,像睡著了一般棒搜。 火紅的嫁衣襯著肌膚如雪疹蛉。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,007評(píng)論 1 284
  • 那天力麸,我揣著相機(jī)與錄音可款,去河邊找鬼。 笑死克蚂,一個(gè)胖子當(dāng)著我的面吹牛闺鲸,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播埃叭,決...
    沈念sama閱讀 38,313評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼摸恍,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了赤屋?” 一聲冷哼從身側(cè)響起立镶,我...
    開封第一講書人閱讀 36,956評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎益缎,沒想到半個(gè)月后谜慌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,441評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡莺奔,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,925評(píng)論 2 323
  • 正文 我和宋清朗相戀三年欣范,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了变泄。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,018評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡恼琼,死狀恐怖妨蛹,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情晴竞,我是刑警寧澤蛙卤,帶...
    沈念sama閱讀 33,685評(píng)論 4 322
  • 正文 年R本政府宣布,位于F島的核電站噩死,受9級(jí)特大地震影響颤难,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜已维,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,234評(píng)論 3 307
  • 文/蒙蒙 一行嗤、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧垛耳,春花似錦栅屏、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至缔莲,卻和暖如春哥纫,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背酌予。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工磺箕, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留奖慌,地道東北人抛虫。 一個(gè)月前我還...
    沈念sama閱讀 45,467評(píng)論 2 352
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像简僧,于是被迫代替她去往敵國(guó)和親建椰。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,762評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容