你忽略的Git提交規(guī)范

一、為什么需要規(guī)范?

無規(guī)矩不成方圓

如果你有一個(gè)項(xiàng)目團(tuán)隊(duì),從始至終都是自己寫,那么你想怎么寫都可以,沒有人可以干預(yù)你。可是如果在團(tuán)隊(duì)協(xié)作中,大家都張揚(yáng)個(gè)性,那么代碼將會是一團(tuán)糟,好好的項(xiàng)目就被槽踐,不管開發(fā)還是日后維護(hù),都將是災(zāi)難。

這時(shí)候,有人提出為何不同統(tǒng)一標(biāo)準(zhǔn),大家都按照這個(gè)標(biāo)準(zhǔn)來,于是Eslint,JSHint 等代碼工具如雨后春歲般涌現(xiàn),成為項(xiàng)目構(gòu)建的必備良品。

Git Commit規(guī)范可能并沒有那么夸張, 但如果你在版本回退的時(shí)候看到一大段糟心的
Commit,空拍會懊惱不已,所以嚴(yán)格遵守規(guī)則,利人利己。

具體規(guī)則

先看看公式

1 | <type>(<scope>): <subject>
  • type

    • 用于說明Commit的類別,只允許使用下面7個(gè)標(biāo)識。

      feat:新功能(feature)
      fix:修補(bǔ)bug
      docs:文檔(documentation)
      style: 格式(不影響代碼運(yùn)行的變動)
      refactor:重構(gòu)(即不是新增功能,也不是修改bug的代碼變動)
      test:增加測試
      chore:構(gòu)建過程或輔助工具的變動
      
  • scope

    • 用于說明 commit 影響的范圍,比如數(shù)據(jù)層、控制層、視圖層等等,視項(xiàng)目不同而不同。
  • subject

    • 是 commit 目的的簡短描述,不超過50個(gè)字符。
    1.以動詞開頭,使用第一人稱現(xiàn)在時(shí),比如change,而不是changed或changes
    2.第一個(gè)字母小寫
    3.結(jié)尾不加句號(.)
    

Commit 規(guī)范的作用

  1. 提供更多的信息,方便排查與回退
  2. 過濾關(guān)鍵字,迅速定位;
  3. 方便生成文檔;

生成 Change log

正如上文提到的生成文檔,如果我們的提交都按照規(guī)范的話,那就很簡單了。生成的文檔包括以下三個(gè)部分:

  • New features
  • Bug fixes
  • Breaking changes.

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

這里需要使用工具 Conventional Changelog 生成 Change log :

npm install -g conventional-changelog
cd jartto-domo
conventional-changelog -p angular -i CHANGELOG.md -w

為了方便使用,可以將其寫入 package.json 的 scripts 字段。

{
  "scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
  }
}

這樣,使用起來就很簡單了:

npm run changelog
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,563評論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,694評論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,672評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,965評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,690評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,019評論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,013評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,188評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,718評論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,438評論 3 360
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,667評論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,149評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,845評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,252評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,590評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,384評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,635評論 2 380

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