git提交規範詳解

一、git提交規範用語

在進行git提交時，需要注意提交信息中的用語規範。一些通用的git提交用語包括：fix（修復bug）、feat（新增功能）、docs（文檔變更）、style（代碼格式變更）、refactor（重構代碼）、test（測試代碼變更）、chore（構建過程或輔助工具變動）等。提交信息應準確表達所做的更改，避免使用不清晰或模糊的用語。

二、git代碼提交規範

在進行git代碼提交時，需要遵循一些規範，其中包括：

1、單個提交僅處理單個邏輯問題；

2、提交不應包含任何無關更改；

3、提交應只關注對代碼的更改，不要包含任何臨時調試代碼；

4、確保提交信息已使用適當的語言和格式編寫，準確傳達所做的更改；

5、在提交信息中提供適當的上下文和說明，避免代碼閱讀者的困惑。

三、git提交規範feat

在git提交規範中，feat代表新特性的開發和實現。當需要在代碼中新增功能時，需要遵循以下規範：

1、確保代碼可讀性良好，包括變量和函數名的明確性；

2、在提交信息中詳細描述新功能；

3、確保新代碼的正確行為，以及它是否遵循有關代碼優化和架構的最佳實踐。

// 代碼示例
// 新增登錄頁面的HTML
<div class="form">
  <form>
    <div class="input">
      <label for="username">用戶名:</label>
      <input type="text" id="username" name="username">
    </div>
    <div class="input">
      <label for="password">密碼:</label>
      <input type="password" id="password" name="password">
    </div>
    <button type="submit">登錄</button>
  </form>
</div>

四、Git提交規範校驗

為了確保代碼提交符合規範，可以使用git hook和代碼走查進行校驗。git hook可以在提交代碼時運行腳本，可以通過設置在提交時觸發的hook，來驗證提交的代碼是否符合規範。代碼走查則可以讓團隊成員一起發揮聰明才智，共同審查代碼。

五、git commit 提交規範

git提交規範需要在進行git commit時注意以下幾點：

1、用一行簡要概括本次提交的內容，可以使用git提交規範用語；

2、接下來在空一行，寫下修改原因、修改內容的詳細描述、修改的影響等信息；

3、如果實在太長，可以在不超過72個字符的位置換行，下一行以一個空格縮進；

4、可以加上關鍵字，方便查找和統計，例如Adding, Removing, Modifying, Fixing等等。

六、git提交代碼的正確步驟

提交代碼應按照以下步驟進行：

1、在修改代碼之前，應從git倉庫拉取最新的代碼，確保在修改時基於最新的版本進行修改；

2、對代碼進行修改並測試；

3、將這些更改提交到本地git倉庫，使用描述性的提交信息；

4、推送提交到遠程git倉庫。

七、git提交代碼不規範攔截

在團隊中使用一些工具，例如Pre-commit、Husky等，可以幫助攔截不規範的代碼提交行為。這些工具可以在提交代碼前運行，自動檢查代碼是否符合某些規範要求，如果有不符合規範要求的，將會被拒絕提交。

八、git commit規範

在進行git commit時，在提交信息中需要包含以下信息：

1、type：用一個代號來表示本次提交類型，例如feat（新增功能）、fix（修復bug）、docs（文檔變更）、style（代碼格式變更）等等；

2、subject：一句話概述本次提交的內容；

3、body：具體闡述本次修改的內容；

4、footer：附加信息，例如issue號、關聯的pull request號等等。

// 代碼示例
// 一個符合規範的git commit提交信息
feat: 新增登錄頁面

為網站添加登錄功能

包括添加的HTML、CSS和JS代碼

fixes #1234

九、git規範

除了git提交規範之外，還有一些git使用的規範：

1、使用合理的分支命名，例如feature_xxx、bugfix_xxx等等；

2、避免提交大量無用的文件或日誌文件，使用.gitignore忽略這些文件；

3、不要在主分支上直接提交代碼，通過分支、合併等方式進行管理。

十、git提交備註規範

在提交時添加適當的備註可以幫助其他人更好地理解代碼。一些基本的git提交備註規範包括：

1、注釋應該是適當的，而不是過於繁瑣或簡單；

2、避免使用無意義的代碼，例如沒有任何維護價值或未使用的代碼；

3、注釋應正確地解釋代碼的行為，不要誤導其他人。

// 代碼示例
// 顯式解釋變量
const age = 16; // 用戶年齡

// 使用注釋解釋某些代碼的行為
if (condition) {
  // 如果條件為真，執行以下代碼
}