Java Git Commit Message使用規範

2022-08-28 14:02:15

概述

不知道大家在各自專案中是如何寫提供程式碼的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內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！