Git Commit 提交規範

一、為什麼需要 Git Commit 提交規範

Git 是一個非常強大的版本管理工具，它可以讓開發者更高效地協同工作。在開發過程中，Git Commit 提交是非常重要的環節，因為它記錄了代碼的改動和進度。

然而，過多的無意義或不規範的提交信息會使得代碼變更追蹤變得困難，給團隊合作和代碼維護造成很大的麻煩。因此，為了更好地管理和追蹤代碼，需要 Git Commit 提交規範。

二、如何制定 Git Commit 提交規範

一個好的 Git Commit 提交規範可以細化每次提交，提高代碼可讀性和可維護性，同時也方便管理和檢查代碼變化。

1. 統一的提交格式

按照統一的提交格式可以讓團隊成員更容易理解和比對每次提交所做的改動。一般的格式包括三個部分：

    type(scope): subject 
    //空一行 
    body
    //空一行 
    footer

其中，type 和 subject 是必需的，body 和 footer 是可選的。下面詳細說明每個部分：

• type：表示本次提交的類型，常見的 type 有以下幾種：
• feat：新增 feature
• fix：修復 bug
• docs：文檔更新
• style：樣式更新等
• refactor：重構代碼
• test：添加或修改測試代碼
• chore：構建過程或輔助工具的變動
• scope：表示改動的範圍，可以是文件名、模塊名等，可選
• subject：簡短描述本次提交的目的，注意使用動詞和第一人稱，例如「增加了新特性」而不是「增加了新特性模塊」
• body：添加詳細的描述和說明，可選
• footer：添加其他相關信息，如關閉 issue 的信息，可選

2. 統一的 Commit Message 模板

制定一個符合需求、簡潔明了、易於使用的模板，可以保證團隊成員按照統一的標準進行提交。例如：

    [type](scope): subject 
    //空一行 
    body
    //空一行 
    footer

3. 個性化 Scope 的使用

在使用時，可以根據實際情況進行個性化定製，例如可以將 scope 指定為文件名、模塊名、功能等，方便查看和搜索變更。

4. 提示性的 Commit Message

為了讓團隊成員更好地理解每個提交和提高代碼可讀性，可以在 Commit Message 中加入一些提示信息，例如使用 emoji 表情、語義化版本號等。

    :tada:(scope): subject 
    //空一行 
    body
    //空一行 
    Version: 1.0.0

三、Git Commit 提交規範的好處

採用規範的 Git Commit 提交方式，可以在一定程度上提供代碼的可讀性和可維護性，在大型項目中流程化、標準化的操作更能發揮其價值。

1. 便於版本管理和跟蹤

規範的 Git Commit 提交格式有助於快速查找、過濾、排序、比對代碼版本，方便代碼追溯與維護。

2. 提高團隊協作效率

規範的提交方式使得團隊成員的提交方式更加一致、準確而不是雜亂，利於項目管理者或其他團隊成員了解本次提交，同時也使得代碼更加易讀和易理解，方便其他成員進行協作開發。

3. 優化開發流程

統一的規範可以提高工作效率，減少重複工作和錯誤提交，更容易定位代碼問題,加快代碼部署的速度。

四、代碼示例

    feat(erp): 增加新需求
    //空一行 
    在erp模塊中增加了訂單創建功能，可在主頁進入
    //空一行 
    :sparkles: :bookmark:

    fix(mobile): 修復產品不顯示的問題
    //空一行 
    在部分移動端上，產品展示出了問題，進行了修復
    //空一行 
    #123

    docs(readme): 更新文檔
    //空一行 
    在 README 中補充了說明相關內容
    //空一行 
    :memo: