Git 提交規范(Git Commit Message Convention)是為了讓項目的提交歷史更加清晰、可讀、便于追蹤和自動化工具解析。常見的規范之一是 Conventional Commits,下面是一個推薦的格式規范:
🌟 提交信息格式(Conventional Commits)
<type>(<scope>): <subject>
type
:提交類型,必填。scope
:影響范圍(模塊、功能、文件名等),可選。subject
:簡潔的描述(不超過 50 字符),必填,首字母小寫,結尾不加句號。
? 常用類型(type)
類型 | 描述 |
---|---|
feat | ? 新功能、新特性 |
fix | 🐛 修復 bug |
docs | 📝 文檔修改 |
style | 💄 格式(空格、分號等,不影響邏輯) |
refactor | 🔨 重構(即不是新功能也不是修復) |
perf | ? 性能優化 |
test | ? 增加測試 |
chore | 🔧 構建過程或輔助工具的變動 |
revert | ? 回退到上一個版本 |
ci | 🤖 CI/CD 配置 |
build | 🏗? 構建系統或依賴變動 |
?? 示例
feat(login): 添加用戶登錄功能fix(api): 修復 getUser 接口返回 500 的問題docs(readme): 更新項目啟動說明style: 調整縮進為 4 空格refactor(auth): 優化權限檢查邏輯test: 增加 login 模塊單元測試chore: 更新 eslint 規則配置
💡 推薦約定
- 原子性:每次提交只做一件事。
- 簡潔明了:
subject
不要寫太長,描述清楚本次變更做了什么。 - 英文 vs 中文:團隊內部可統一用中文或英文,但建議保持一致。
需要我幫你自動生成 Git 提交模版或者寫個腳本規范提交信息嗎?