Git提交規(guī)范

Git提交規(guī)范
Git Hook - 實(shí)現(xiàn)commit-msg自動(dòng)裝飾

格式:

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

<body>

<footer>

例子:

feat(user): Add user registration [777]

Use Tencent cloud verification code to verify mobile phone 
and add user registration function

https://github.com/one-user/a-project/issues/777

type [必須]

用于說(shuō)明 commit 的類別炎功,只允許使用下面幾種標(biāo)識(shí):

  • feat:新功能(feature)
  • fix:修補(bǔ)bug
  • docs:文檔(documentation)
  • style: 格式(不影響代碼運(yùn)行的變動(dòng))
  • refactor:重構(gòu)(即不是新增功能劳殖,也不是修改bug的代碼變動(dòng))
  • perf:優(yōu)化
  • test:增加測(cè)試
  • chore:構(gòu)建過(guò)程或輔助工具的變動(dòng)
  • revert:撤銷上一次的 commit

scope [必須]

用于說(shuō)明修改的范圍督暂,基本上有有以下幾種情形:

  • all:表示大范圍的修改
  • loation:表示小范圍的修改
  • module:表示修改了某個(gè)模塊 例如:feat(user): add user login

subject [必須]

用于表示本次提交修改的簡(jiǎn)要說(shuō)明,盡量簡(jiǎn)短

ISSUE_ID [可選]

添加在 git issues 中需求或者 bug 修復(fù)對(duì)應(yīng)的 issues 記錄ID

body [可選]

body中就是 subject的詳細(xì)說(shuō)明

footer [可選]

可以寫(xiě)備注逊移,填寫(xiě)相關(guān)的需求管理 issues id

commit-msg hook

如何保證每一次commit-msg信息格式的準(zhǔn)備,可以是使用commit-msg hook

hook規(guī)則文件模板

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末葡盗,一起剝皮案震驚了整個(gè)濱河市螟左,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌觅够,老刑警劉巖胶背,帶你破解...
    沈念sama閱讀 222,681評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異喘先,居然都是意外死亡钳吟,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門窘拯,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)红且,“玉大人,你說(shuō)我怎么就攤上這事涤姊∠痉” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,421評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵思喊,是天一觀的道長(zhǎng)壁酬。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么舆乔? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,114評(píng)論 1 300
  • 正文 為了忘掉前任岳服,我火速辦了婚禮,結(jié)果婚禮上希俩,老公的妹妹穿的比我還像新娘吊宋。我一直安慰自己,他們只是感情好颜武,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,116評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布璃搜。 她就那樣靜靜地躺著,像睡著了一般盒刚。 火紅的嫁衣襯著肌膚如雪腺劣。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,713評(píng)論 1 312
  • 那天因块,我揣著相機(jī)與錄音橘原,去河邊找鬼。 笑死涡上,一個(gè)胖子當(dāng)著我的面吹牛趾断,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播吩愧,決...
    沈念sama閱讀 41,170評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼芋酌,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了雁佳?” 一聲冷哼從身側(cè)響起脐帝,我...
    開(kāi)封第一講書(shū)人閱讀 40,116評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎糖权,沒(méi)想到半個(gè)月后堵腹,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,651評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡星澳,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,714評(píng)論 3 342
  • 正文 我和宋清朗相戀三年疚顷,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片禁偎。...
    茶點(diǎn)故事閱讀 40,865評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡腿堤,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出如暖,到底是詐尸還是另有隱情笆檀,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布盒至,位于F島的核電站误债,受9級(jí)特大地震影響浸船,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜寝蹈,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,211評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望登淘。 院中可真熱鬧箫老,春花似錦、人聲如沸黔州。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,699評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)流妻。三九已至牲蜀,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間绅这,已是汗流浹背涣达。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,814評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留证薇,地道東北人度苔。 一個(gè)月前我還...
    沈念sama閱讀 49,299評(píng)論 3 379
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像浑度,于是被迫代替她去往敵國(guó)和親寇窑。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,870評(píng)論 2 361

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

  • git的規(guī)范和相關(guān)科普知識(shí) git commit 的規(guī)范要求(參考Angular團(tuán)隊(duì)) message格式如下: ...
    達(dá)文西_Huong閱讀 762評(píng)論 0 0
  • Git 提交規(guī)范 制定一個(gè) git commit 信息的提交規(guī)范是開(kāi)發(fā)團(tuán)隊(duì)工作流必不可少的環(huán)節(jié)箩张。試想一下甩骏,如果查看...
    十月里的男藝術(shù)家閱讀 803評(píng)論 0 0
  • 前言在提交commit信息時(shí),為了統(tǒng)一規(guī)范commit信息先慷,可以在Git Hooks中編寫(xiě)修改commit-msg...
    Cuccci閱讀 339評(píng)論 1 0
  • 久違的晴天饮笛,家長(zhǎng)會(huì)。 家長(zhǎng)大會(huì)開(kāi)好到教室時(shí)熟掂,離放學(xué)已經(jīng)沒(méi)多少時(shí)間了缎浇。班主任說(shuō)已經(jīng)安排了三個(gè)家長(zhǎng)分享經(jīng)驗(yàn)。 放學(xué)鈴聲...
    飄雪兒5閱讀 7,528評(píng)論 16 22
  • 今天感恩節(jié)哎赴肚,感謝一直在我身邊的親朋好友素跺。感恩相遇!感恩不離不棄誉券。 中午開(kāi)了第一次的黨會(huì)指厌,身份的轉(zhuǎn)變要...
    迷月閃星情閱讀 10,576評(píng)論 0 11