我司的 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ì)描述,可以分成多行。