git commit message規(guī)范

1、背景

在使用git時吠谢,每次代碼提交都需要寫commit message作為git log以便于項目管理。
然而在日常的團隊開發(fā)中,每個人的commit message千奇百怪静暂,規(guī)范不一致,中英文混合使用等問題谱秽,會導致項目git log格式混亂洽蛀、不便維護。因此疟赊,構(gòu)建一份結(jié)構(gòu)清晰郊供、簡潔優(yōu)雅的commit message規(guī)范不僅有助于高效管理項目、降低維護成本听绳,也方便團隊成員之間review颂碘、提高研發(fā)效率。

2椅挣、commit message規(guī)范

<type>[(<scope>)]: <subject>

其中头岔,<type> 和 <subject>是必填項,(<scope>)是選填項
下面對這三個模塊詳細闡述:

2.1 type

type用于聲明本次代碼提交的類型(英文鼠证,必填項)峡竣,通常是在滿足一個技術(shù)和業(yè)務域需求的條件下的團隊約定的有限集合,便于成員統(tǒng)一共識量九,不宜太多導致類型太散适掰、不便記憶,也不宜太少荠列,無法有效區(qū)分类浪。
從算法團隊角度出發(fā),將類型限定在如下集合:
feat:新功能特性肌似。
fix:bug修復费就。
perf:功能優(yōu)化,包括性能優(yōu)化川队、體驗優(yōu)化等力细。
refactor:代碼重構(gòu)(大范圍的代碼結(jié)構(gòu)重構(gòu),不涉及代碼功能)
style:格式調(diào)整(小范圍的代碼格式調(diào)整固额,不涉及代碼功能)
merge:代碼分支合并
revert:代碼版本回滾
test:測試代碼變動
doc:文檔變動

2.2 scope

scope用于聲明本次代碼提交的影響范圍(建議英文眠蚂,選填項),如Model層斗躏、Dao層逝慧、Service層、Controller層、View層等等笛臣。
如果涉及多個scope栅干,可以置空或用*代替。

2.3 subject

subject用于聲明本次代碼提交的描述信息(建議中文捐祠,必填項)碱鳞。
通常控制在50個字符內(nèi)踱蛀,且省略句末標點符號窿给。

以上是一些基本的 commit message規(guī)范,項目的復雜性和業(yè)務域不同率拒,可能會有不同的調(diào)整或補充崩泡,就以上規(guī)范,列舉幾個示例如下:

feat(Controller):商品屬性識別接口開發(fā)
fix(Service):入?yún)⑦吔鐧z查條件不足

參考文獻

如何規(guī)范你的Git commit猬膨?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末角撞,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子勃痴,更是在濱河造成了極大的恐慌谒所,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件沛申,死亡現(xiàn)場離奇詭異劣领,居然都是意外死亡,警方通過查閱死者的電腦和手機铁材,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進店門尖淘,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人著觉,你說我怎么就攤上這事村生。” “怎么了饼丘?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵趁桃,是天一觀的道長。 經(jīng)常有香客問我葬毫,道長镇辉,這世上最難降的妖魔是什么屡穗? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任贴捡,我火速辦了婚禮,結(jié)果婚禮上村砂,老公的妹妹穿的比我還像新娘烂斋。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布汛骂。 她就那樣靜靜地躺著罕模,像睡著了一般。 火紅的嫁衣襯著肌膚如雪帘瞭。 梳的紋絲不亂的頭發(fā)上淑掌,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天,我揣著相機與錄音蝶念,去河邊找鬼抛腕。 笑死,一個胖子當著我的面吹牛媒殉,可吹牛的內(nèi)容都是我干的担敌。 我是一名探鬼主播,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼廷蓉,長吁一口氣:“原來是場噩夢啊……” “哼全封!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起桃犬,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤刹悴,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后攒暇,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體颂跨,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年扯饶,在試婚紗的時候發(fā)現(xiàn)自己被綠了恒削。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡尾序,死狀恐怖钓丰,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情每币,我是刑警寧澤携丁,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站兰怠,受9級特大地震影響梦鉴,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜揭保,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一肥橙、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧秸侣,春花似錦存筏、人聲如沸宠互。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽予跌。三九已至,卻和暖如春善茎,著一層夾襖步出監(jiān)牢的瞬間券册,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工垂涯, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留汁掠,地道東北人。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓集币,卻偏偏與公主長得像考阱,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子鞠苟,可洞房花燭夜當晚...
    茶點故事閱讀 43,472評論 2 348