git 提交備註規範

猫猫客服發表於2024-06-22

git 提交規範
commit message = subject + :+ 空格 + message 主體

例如:feat::增加使用者註冊功能

常見的 subject 種類以及含義如下:

feat: 新功能(feature)

用於提交新功能。
例如:feat: 增加使用者註冊功能
fix: 修復 bug

用於提交 bug 修復。
例如:fix: 修復登入頁面崩潰的問題
docs: 文件變更

用於提交僅文件相關的修改。
例如:docs: 更新README檔案
style: 程式碼風格變動(不影響程式碼邏輯)

用於提交僅格式化、標點符號、空白等不影響程式碼執行的變更。
例如:style: 刪除多餘的空行
refactor: 程式碼重構(既不是新增功能也不是修復bug的程式碼更改)

用於提交程式碼重構。
例如:refactor: 重構使用者驗證邏輯
perf: 效能最佳化

用於提交提升效能的程式碼修改。
例如:perf: 最佳化圖片載入速度
test: 新增或修改測試

用於提交測試相關的內容。
例如:test: 增加使用者模組的單元測試
chore: 雜項(構建過程或輔助工具的變動)

用於提交構建過程、輔助工具等相關的內容修改。
例如:chore: 更新依賴庫
build: 構建系統或外部依賴項的變更

用於提交影響構建系統的更改。
例如:build: 升級webpack到版本5
ci: 持續整合配置的變更

用於提交CI配置檔案和指令碼的修改。
例如:ci: 修改GitHub Actions配置檔案
revert: 回滾

用於提交回滾之前的提交。
例如:revert: 回滾feat: 增加使用者註冊功能
總結
使用規範的提交訊息可以讓專案更加模組化、易於維護和理解,同時也便於自動化工具(如釋出工具或 Changelog 生成器)解析和處理提交記錄。

透過編寫符合規範的提交訊息,可以讓團隊和協作者更好地理解專案的變更歷史和版本控制,從而提高程式碼維護效率和質量。
————————————————

版權宣告:本文為博主原創文章,遵循 CC 4.0 BY-SA 版權協議,轉載請附上原文出處連結和本宣告。

原文連結:https://blog.csdn.net/chenyajundd/article/details/139322838

相關文章