常見的Git 程式碼提交規範,feat、fix、style都是什麼意思?

爱上大树的小猪發表於2024-11-25

在使用 Git 進行版本控制時,遵循一定的提交資訊規範是非常重要的。這不僅可以幫助團隊成員更容易地理解每次提交的目的和影響,還能提高程式碼審查的效率。常見的 Git 提交資訊規範之一是 Conventional Commits 規範,它定義了一套標準化的提交資訊格式。以下是幾個常用的提交字首及其含義:

1. feat (Feature)

  • 含義:表示新增功能(feature)的提交。
  • 示例:feat: add night mode to the application
  • 描述:用於描述新功能的新增,比如增加了一個新的使用者介面特性或後端服務功能。

2. fix (Fix)

  • 含義:表示修復錯誤(bug fix)的提交。
  • 示例:fix: resolve null pointer exception in user login
  • 描述:用於修復程式碼中的錯誤或問題,確保程式的行為符合預期。

3. style (Style)

  • 含義:表示程式碼樣式修改的提交,不影響程式邏輯。
  • 示例:style: update code formatting according to ESLint rules
  • 描述:用於改進程式碼風格,例如調整縮排、空格、換行等,通常不會改變程式碼的功能。

4. revert: 回滾

  • 含義:用於提交回滾之前的提交。
  • 示例:revert: 回滾feat: 增加使用者註冊功能。
  • 描述:用於直接明確回滾的程式碼,包含了那些歷史功能模組。

5. build: 構建系統或外部依賴項的變更

  • 含義:用於提交影響構建系統的更改。
  • 示例:build: 升級webpack到版本5。
  • 描述:用於打包構建專案的描述,或者更改了相關依賴等。

其他常見字首

  • refactor (Refactor):

    • 含義:表示程式碼重構,即不改變程式碼功能的情況下最佳化程式碼結構。
    • 示例:refactor: simplify complex function logic
  • docs (Documentation):

    • 含義:表示文件更新,如 README 檔案、API 文件等。
    • 示例:docs: update installation guide for v2.0
  • test (Test):

    • 含義:表示測試相關的更改,如新增或修改測試用例。
    • 示例:test: add unit tests for new feature
  • chore (Chore):

    • 含義:表示維護任務,如更新依賴項、配置檔案等。
    • 示例:chore: update package.json dependencies
  • perf (Performance):

    • 含義:表示效能最佳化的提交。
    • 示例:perf: optimize database query performance
  • ci (Continuous Integration):

    • 含義:表示持續整合相關的更改,如 CI/CD 配置檔案的更新。
    • 示例:ci: configure GitHub Actions for automated testing
遵循這樣的規範可以使團隊協作更加高效,程式碼歷史也更易於理解和維護。

相關文章