Git commit 注釋規(guī)范

我司的 Git commit 規(guī)范,在項(xiàng)目的 pre-commit 鉤子中校驗(yàn)。
好像很多公司的規(guī)范都是這樣,做個(gè)記錄

提交格式:

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

范例:

fix: feat(0429留言下單): add 'graphiteWidth' option

提交的具體情況

說(shuō)明:

type(必需)、scope(可選)和subject(必需)。

<body>(可選)

(1) type

  • type用于說(shuō)明 commit 的類別,只允許使用下面8個(gè)標(biāo)識(shí)。
  • br: 此項(xiàng)特別針對(duì)bug號(hào),用于向測(cè)試反饋bug列表的bug修改情況
  • feat:新功能(feature)
  • fix:修補(bǔ)bug
  • docs:文檔(documentation)
  • style: 格式(不影響代碼運(yùn)行的變動(dòng))
  • refactor:重構(gòu)(即不是新增功能,也不是修改bug的代碼變動(dòng))
  • test:增加測(cè)試
  • chore:構(gòu)建過(guò)程或輔助工具的變動(dòng)
  • revert: feat(pencil): add 'graphiteWidth' option (撤銷之前的commit)

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

(3)subject
subject是 commit 目的的簡(jiǎn)短描述,不超過(guò)50個(gè)字符。
以動(dòng)詞開(kāi)頭,使用第一人稱現(xiàn)在時(shí),比如change,而不是changed或changes
第一個(gè)字母小寫(xiě)
結(jié)尾不加句號(hào)(.)

(4)Body 部分是對(duì)本次 commit 的詳細(xì)描述,可以分成多行。

最后編輯于
?著作權(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)容

  • 整理自《Commit message 和 Change log 編寫(xiě)指南》-阮一峰 Commit message目...
    huanqiang閱讀 25,377評(píng)論 0 8
  • Git 每次提交代碼,都要寫(xiě) Commit message(提交說(shuō)明),否則就不允許提交。 上面代碼的-m參數(shù),就...
    andyJi閱讀 2,989評(píng)論 0 0
  • Git 每次提交代碼, 都要寫(xiě) Commit message (提交說(shuō)明), 否則就不允許提交 $ git com...
    oneofai閱讀 14,744評(píng)論 1 2
  • git 每次提交代碼都會(huì)有message說(shuō)明本次commit的目的。 一. commint 介紹 命令 目前,社區(qū)...
    EdmundChen閱讀 11,395評(píng)論 0 5
  • Git 是目前最流行的源代碼管理工具。可以方便的維護(hù)和管理團(tuán)隊(duì)合作項(xiàng)目。 但若沒(méi)有一個(gè)合理,規(guī)范的分支命名和管理,...
    Walkerc閱讀 816評(píng)論 0 1

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