深圳大演繹科技 開發人員 Git 使用規范

深圳大演繹科技 開發人員 Git 使用規范

一、提交規范

1、提交時commit不得為空

2、格式

提交信息包括兩個部分:Header,Body

<Header>

<Body>

其中,Header 是必需的,BodyFooter 可以省略。

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: 添加了分享功能

給每篇博文添加了分享功能

- 添加分享到微博功能
- 添加分享到微信功能
- 添加分享到朋友圈功能

務必清晰簡潔

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Git 每次提交代碼, 都要寫 Commit message (提交說明), 否則就不允許提交 $ git com...
    oneofai閱讀 14,509評論 1 2
  • Git 每次提交代碼,都要寫 Commit message(提交說明),否則就不允許提交。 上面代碼的-m參數,就...
    andyJi閱讀 2,913評論 0 0
  • 整理自《Commit message 和 Change log 編寫指南》-阮一峰 Commit message目...
    huanqiang閱讀 25,150評論 0 8
  • Git 基礎用法 SVN與Git(集中式VS分布式) 集中式 分布式 工作區 電腦中能夠看到的目錄就是工作區。 版...
    GeekerHua閱讀 622評論 0 0
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,932評論 18 139