在團隊協作中,Git 提交規范對于代碼的可維護性和版本管理非常重要,下面總結了一些常見的提交規范:
提交資訊格式
每個 Git 提交資訊都應該包含一個清晰簡潔的標題和一個更詳細的描述,推薦的提交資訊格式如下:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
其中,<type> 代表提交型別,<scope> 代表影響范圍,<subject> 是提交資訊的簡短描述,<body> 是詳細描述,<footer> 是一些元資料,比如關聯的 issue、PR 等,
提交型別
常見的提交型別包括:
feat:新功能fix:修復 bugdocs:檔案修改style:代碼格式修改,比如縮進、空格等refactor:代碼重構test:測驗相關修改chore:其他修改,比如構建流程、輔助工具等
影響范圍
<scope> 表示影響的范圍,可以是檔案名、模塊名、功能名等,也可以省略不寫,
提交資訊示例
下面是一個示例提交資訊的格式:
feat(proto-gen): 協議匯出c++
支持協議自動生成c++代碼
Closes #123
在這個示例中,feat(proto-gen) 表示添加了新功能,協議匯出c++ 是簡要描述,支持了協議匯出c++代碼, 支持協議自動生成c++代碼 是提交資訊的詳細描述,Closes #123 表示關聯了 Issue #123,
總結
遵循 Git 提交規范可以讓團隊協作更加高效和規范,也更容易進行版本管理和代碼維護,希望大家都能養成良好的提交習慣!
轉載請註明出處,本文鏈接:https://www.uj5u.com/gongcheng/546881.html
標籤:其他
