爲規範開發,保持代碼提交記錄以及 git 分支結構清晰,方便後續維護,現規範 git 的相關操作。
主要規範兩點:
- git 分支命名規範
- git 提交記錄規範
1. git 分支命名規範
git 分支分爲集成分支、功能分支和修復分支,分別命名爲 develop、feature 和 hotfix,均爲單數。不可使用 features、future、hotfixes、hotfixs 等錯誤名稱。
- master(主分支,永遠是可用的穩定版本,不能直接在該分支上開發)
- develop(開發主分支,所有新功能以這個分支來創建自己的開發分支,該分支只做只合並操作,不能直接在該分支上開發)
- feature-xxx(功能開發分支,在develop上創建分支,以自己開發功能模塊命名,功能測試正常後合併到develop分支)
- feature-xxx-fix(功能bug修復分支,feature分支合併之後發現bug,在develop上創建分支修復,之後合併回develop分支。PS:feature分支在申請合併之後,未合併之前還是可以提交代碼的,所以feature在合併之前還可以在原分支上繼續修復bug)
- hotfix-xxx(緊急bug修改分支,在master分支上創建,修復完成後合併到 master)
注意事項:
- 一個分支儘量開發一個功能模塊,不要多個功能模塊在一個分支上開發。
- feature 分支在申請合併之前,最好是先 pull 一下 develop 主分支下來,看一下有沒有衝突,如果有就先解決衝突後再申請合併。
2. git 提交記錄規範
每個 git commit 記錄都需要按照固定格式,具體格式爲:
第一行:作者: 功能模塊名稱(或 功能模塊ID)
第二行:提交描述,中英文皆可
+ :增加代碼
* :修改代碼
- : 刪除代碼
原文:https://www.cnblogs.com/yorkyang/p/9147309.html