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 的類(lèi)別,只允許使用下面幾種標(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:撤銷(xiāo)上一次的 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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • git的規(guī)范和相關(guān)科普知識(shí) git commit 的規(guī)范要求(參考Angular團(tuán)隊(duì)) message格式如下: ...
    達(dá)文西_Huong閱讀 872評(píng)論 0 0
  • Git 提交規(guī)范 制定一個(gè) git commit 信息的提交規(guī)范是開(kāi)發(fā)團(tuán)隊(duì)工作流必不可少的環(huán)節(jié)。試想一下,如果查看...
    十月里的男藝術(shù)家閱讀 899評(píng)論 0 0
  • 前言在提交commit信息時(shí),為了統(tǒng)一規(guī)范commit信息,可以在Git Hooks中編寫(xiě)修改commit-msg...
    Cuccci閱讀 436評(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,866評(píng)論 16 22
  • 今天感恩節(jié)哎,感謝一直在我身邊的親朋好友。感恩相遇!感恩不離不棄。 中午開(kāi)了第一次的黨會(huì),身份的轉(zhuǎn)變要...
    余生動(dòng)聽(tīng)閱讀 10,912評(píng)論 0 11

友情鏈接更多精彩內(nèi)容