chensongbiao

git的提交規范包括兩個字段：type（必需）和subject（必需）

type用于說明 commit 的類別，只允許使用下面9個標識。

feat: 新功能（feature）

fix: 修補bug

docs: 文檔（documentation）

style: 格式（不影響代碼運行的變動）

refactor: 重構（即不是新增功能，也不是修改bug的代碼變動）

chore: 構建過程或輔助工具的變動

revert: 撤銷，版本回退

perf: 性能優化

test：測試

improvement: 改進

build: 打包

ci: 持續集成

subject是 commit 目的的簡短描述，不超過50個字符。

示例:

    feat(example): 訂單詳情增加導出功能

    -訂單詳情新增導出功能

feat() 括號內的內容通常用來指明該功能更改的影響范圍或上下文

作用域的選擇

選擇合適的作用域取決于你的項目結構和團隊約定。以下是幾個例子：

• 按模塊或功能區劃分：如果你的項目由多個獨立的功能模塊組成，那么可以在括號內填寫模塊名。

  • 示例：feat(user-auth): 添加兩步驗證支持

• 按前端框架組件劃分：對于使用如 React, Vue 等前端框架的項目，可能會按照組件來組織。

  • 示例：feat(Header): 增加導航欄的新按鈕

• 按后端服務或API端點劃分：如果是在服務端工作，可能根據API端點或服務命名。

  • 示例：feat(api/v2/users): 支持批量用戶創建

• 按文件夾或目錄劃分：有時也直接使用文件夾名稱作為作用域。

  • 示例：feat(src/components): 更新組件樣式

• 按技術或庫劃分：當更改特別針對某個庫或技術時，也可以用它作為作用域。

  • 示例：feat(express): 升級到Express 5.0

• 其他自定義作用域：根據項目的具體需求，還可以使用其他任何有助于描述更改范圍的標識符。

注意事項

• 遵循團隊規范：確保你遵循所在團隊或項目已有的提交信息格式和約定。
• 保持一致性：一旦確定了作用域的規則，盡量在整個項目中保持一致。
• 簡潔明了：作用域應該簡短且具有描述性，避免過長或過于模糊。

括號中的內容是為了提供額外的上下文，幫助更好地理解和分類提交。因此，選擇能夠清晰表達更改影響范圍的詞匯是非常重要的。