深圳大演繹科技 開發人員 Git 使用規范
一、提交規范
1、提交時commit不得為空
2、格式
提交信息包括兩個部分:Header,Body
<Header>
<Body>
其中,Header
是必需的,Body
和 Footer
可以省略。
Header:
Header部分只有一行,包括倆個字段:type(必需)和subject(必需)。
<type>: <subject>
type
用于說明 commit 的類別,可以使用如下類別(如果一次提交可以有多個類別,使用主要的類別):
-
feat
:新功能(feature) -
fix
:修補bug -
doc
:文檔(documentation) -
style
: 格式(不影響代碼運行的變動) -
refactor
:重構(即不是新增功能,也不是修改bug的代碼變動) -
test
:增加測試 -
chore
:構建過程或輔助工具的變動
subject
是 commit 目的的簡短描述。
結尾不加句號(。)
Body
Body 部分是對本次 commit 的詳細描述,可以分成多行。下面是一個范例。
- 修改了XXX界面的邏輯,用來處理XXX情況
- 增加相應的單元測試
注意:應該說明代碼變動的動機,以及與以前行為的對比。
Footer
3、例子
下面是一個完整的例子:
feat: 添加了分享功能
給每篇博文添加了分享功能
- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能
務必清晰簡潔