在使用 Git 提交時,遵循良好的提交消息規范可以提高代碼的可讀性和可維護性。以下是一些常見的 Git 提交消息書寫規范:
-
提交消息格式:一個提交消息通常包含三個部分:標題、空行和正文。它們之間使用空行分隔。
復制
<標題><正文> ```
-
標題(Title):
- 簡潔明了:標題應該簡明扼要地描述該提交的概要內容。
- 首字母大寫:標題的首字母通常大寫。
- 動詞使用一般現在時:使用一般現在時來描述提交所做的更改。例如,使用 "Fix" 而不是 "Fixed",使用 "Add" 而不是 "Added"。
-
正文(Body):
- 可選項:正文是可選的,可以用于提供更詳細的信息。
- 解釋性描述:如果標題本身不足以解釋提交的更改內容,可以在正文中提供更多的背景、原因、目的等信息。
- 分段落:對于較長的正文,可以使用適當的分段落來提高可讀性。
-
提交類型(Commit Type):根據提交的目的和內容,可以使用不同的提交類型標識。常見的提交類型包括但不限于以下幾種:
feat
:新增功能(feature)fix
:修復問題(bug fix)docs
:文檔更新style
:代碼樣式調整(不影響代碼功能)refactor
:重構代碼(既不修復錯誤也不添加功能)test
:添加或修改測試代碼chore
:構建過程或輔助工具的變動
你可以根據具體的項目或團隊規范定義自己的提交類型。
-
提交范圍(Commit Scope):可選項,用于指定提交更改的范圍或相關模塊。范圍應該簡潔明了,例如文件名、模塊名等。
下面是一個示例提交消息的格式:
feat: Add user registration functionality- Implement user registration form
- Validate user input
- Store user data in databaseFixes #123
在上面的示例中,提交類型為?feat
(新增功能),標題為 "Add user registration functionality",正文中提供了一些具體的更改描述。最后,使用 "Fixes #123" 的格式可以關聯提交與特定的問題或任務(這取決于你使用的任務跟蹤系統)。
請根據你的實際項目和團隊規范來定義適合自己的提交消息書寫規范。保持一致和清晰的提交消息可以幫助團隊成員更好地理解和追蹤代碼更改。