關于git提交規范

良好的Commit Message有利于代碼審查,能更快速查找變更記錄,并且可以直接生成Change log。

angular規范

為了規范代碼提交的說明,這里我們使用angular的規范寫法:

<type>(<scope>): <subject> #header
// 空一行
<body>
// 空一行
<footer> 

格式講解

Header

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

總的來說,關鍵就是header這部分,至于<body><footer>可省略

例如:

feat:新增財務報表

type

用于說明本次commit的類別,只允許使用下面7個標識

  • feat:新功能(feature)
  • fix:修補bug
  • docs:文檔(documentation)
  • style: 格式(不影響代碼運行的變動)
  • refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
  • test:增加測試
  • chore:構建過程或輔助工具的變動
    :::tip
    注意:如果type為feat和fix,則該 commit 將肯定出現在 Change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 Change log,建議是不要。
    :::

scope

用于說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。
例如:

git commit -m "feat(module:user):添加用戶模塊"

此提交記錄中的module:user說明提交的代碼影響的是user模塊內容.

subject

是 commit 目的的簡短描述,不超過50個字符。

以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes
第一個字母小寫
結尾不加句號(.)

使用commitizen來執行規范

  1. 全局安裝commitizennode模塊
npm install -g commitizen
  1. 在項目目錄下運行命令
commitizen init cz-conventional-changelog --save --save-exact
  1. 運行完以上一律使用git cz 代替git commit來提交代碼,同時會顯示一下選項來自動生成符合格式的commit message.
    img

按照提示,你可以寫出規范的message了

參考文章

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

推薦閱讀更多精彩內容

  • 原文鏈接 前言 在git的使用中,一種最佳實踐是使用格式化的commit信息,這樣方便自動化工具進行處理,可以快速...
    馮宇Ops閱讀 8,635評論 2 34
  • 前言 Git 每次提交代碼,都要寫 Commit message(提交說明),否則就不允許提交。但是,一般來說,c...
    guanguans閱讀 126,318評論 1 63
  • 分支 master分支為主分支(保護分支),不能直接在master上進行修改代碼或提交,通過MR(merge Re...
    小花生_peanut閱讀 7,020評論 0 4
  • git 提交規范 前言 無規矩不成方圓,編程也一樣。 如果你有一個項目,從始至終都是自己寫,那么你想怎么寫都可以,...
    janlle閱讀 447評論 0 1
  • 上午辦理出院手續,回到13B病房。有幾位病友正開心聊著天,時不時發出爽朗的笑聲,似乎忘了各自的病情。此時,進來一位...
    我撿了九條貓閱讀 135評論 0 0