Java Git Commit Message使用規范

Posted on by

概述

不知道大傢在各自項目中是如何寫提供代碼的commit message, 我們項目有的同事寫的很簡單，壓根不知道提交瞭什麼內容，是新功能還是缺陷修復。本質上 commit message就是為瞭讓團隊成員知道這次提交的內容，為此，我們出瞭一個規范，約定團隊的每個同事按照這個規范提交代碼，達到通過message能夠瞭解此次修改的內容。

一、Commit message 的格式

每次提交，Commit message 都包括三個部分：Header，Body 和 Footer。

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

其中，Header、針對feat和fix類型的提交內容 Body 是必需的。 不管是哪一個部分，任何一行都不得超過72個字符（或100個字符）。這是為瞭避免自動換行影響美觀。

1.1 Header

Header部分隻有一行，包括三個字段： type（必需）、scope（必需）和subject（必需）。
（1）type
type用於說明 commit 的類別，隻允許使用下面7個標識。

  • feat：新功能（feature）
  • fix：修補bug
  • docs：文檔（documentation）
  • style： 格式（不影響代碼運行的變動）
  • refactor：重構（即不是新增功能，也不是修改bug的代碼變動）
  • test：增加測試
  • build：構建過程或輔助工具的變動

（2）scope
scope用於說明 commit 影響的范圍，比如指標模板、規則上下線等等，視項目不同而不同。
（3）subject
subject是 commit 目的的簡短描述，不超過50個字符。

  • 1. 以動詞開頭，使用第一人稱現在時，比如change，而不是changed或changes
  • 2. 第一個字母小寫
  • 3. 結尾不加句號（.）

1.2 Body

Body 部分是對本次 commit 的詳細描述，可以分成多行。

  • 1. 需要簡要的列出各種正向或者反向的測試場景，測試通過，填pass。
  • 2. 增加修改人信息

二、例子

2.1 feat例子

feat(規則上下線、構建、生效、仿真生效): 添加規則上下線功能 

1. 規則上下線主流程，引擎正常訂閱，fldl生成正常。 pass
2. 規則上下線，傳入不存在的規則編號，異常提示。 pass

提交人：xxx

2.2 fix例子

fix(模型模塊): 模型測試失敗

1. 導入mar模型，包含衍生字段。 pass
2. 導入mar模型，不包含衍生字段。 pass

提交人：xxx

插件推薦

idea可以安裝代碼提交規范的插件。

1.安裝插件

 2.提交時選擇插件提交

到此這篇關於Java Git Commit Message使用規范的文章就介紹到這瞭,更多相關Java Git Commit Message內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：