Git 代碼提交規範

一、為什麼需要規範化提交Git代碼？

規範化提交 Git 代碼的好處是顯而易見的，它可以幫助開發者節省時間，提高團隊合作效率，更好地管理代碼版本，避免帶來潛在的問題。

在一個大型項目中，參與其中的開發者可能會有很多，這就需要統一代碼提交規範來簡化代碼管理。而規範化代碼提交也能夠幫助團隊及時發現代碼中的問題，避免衝突和出錯，為整個項目開發帶來秩序和規範性。

值得提醒的是，Git 代碼提交規範不是一種奇術，只有你在實際開發中將其運用才能發掘其真正價值。

二、 Git 提交消息規範

在 Git 中，每一次提交都需要有一次提交消息，這個提交消息就是一段文字說明。規範的提交消息不僅使得 Git 歷史記錄易於閱讀，而且在查詢和研究項目代碼的歷史記錄時非常有用。

下面是提交消息的標準格式：

    類型: 主題

    主體內容

    應用範圍

其中，提交消息主要包括以下3個部分：

1、類型：對提交的修改進行分類，主要包括以下類型：

• feature：新功能
• fix：修復問題
• docs：只修改了文檔
• style：代碼風格美化、格式修正等無關功能代碼變更
• refactor：代碼重構
• test：測試相關
• chore：其他不影響代碼功能的更改，比如構建工具、依賴庫等的更新或者二次封裝

2、主題：是一個簡短的、準確的描述，通常不超過50個字符。主題應該簡潔地概括修改做了什麼，而不是說明修改為什麼而做什麼。

3、主體內容：是一個更長的、更詳細的、對提交所做的修改進行詳細解釋的內容。主體內容可以是多行，通常不超過72個字符，中間以空行隔開。

三、 Git 分支命名規範

Git 分支是開發者在 Git 倉庫中角色的一種，可以方便地管理代碼的版本。當需要開發新功能或者修復已知的 Bug 時，我們通常需要新建一個分支，此時需要遵循分支命名規範，以便更好地管理代碼。

分支名通常由以下幾部分組成：

    // 

其中，類型指的是該分支所屬的類型，建議使用以下幾種類型：

• feature：功能開發分支；
• bugfix：問題修復分支；
• hotfix：緊急問題修復分支；
• release：發佈版本分支，每次發佈一個新的版本都需要新建一個 release 分支；
• docs：文檔更新分支；

名稱是指分支的名稱，使用 – 來作為單詞的分隔符。

數字 ID 是指相關需求、缺陷、任務的 ID，這樣可以方便地對問題進行追蹤。

四、 Git Commitizen 工具的使用

Commitizen 是一款優秀的 Git 提交信息規範工具，支持 Commit message 格式化，可視化地選擇修改類型、影響的範圍、文件名等。

使用 Commitizen 可以大大提升代碼提交的規範化和效率化，我們只需要根據一個簡單的命令格式輸入相關信息即可生成規範的提交信息。

    npm install -g commitizen
    commitizen init cz-conventional-changelog --save-dev --save-exact
    git cz

在執行 git cz 命令之後，會啟動 Commitizen 客戶端，並通過一步步提問的形式來生成規範的提交消息。

五、規範化 Git 提交動作

規範化 Git 提交過程中，我們不僅需要關注提交的消息格式、分支命名規範等，還需要關注實際提交前的一系列操作。下面我們來談一談規範化提交動作的相關內容。

要規範化提交動作，我們需要明確的了解提交的流程，以及相關的規範化操作，如下：

• Git reset 和 Git revert 的使用；
• Git squash 的使用；
• 代碼合併的規範化流程。

六、 總結

Git 代碼提交規範對於項目的管理和團隊的協作效率非常有幫助，本文通過實際經驗介紹了 Git 提交消息規範、Git 分支命名規範、Commitizen 工具的使用以及規範化 Git 提交動作等內容。