git 分支命名規范


為規范開發,保持代碼提交記錄以及 git 分支結構清晰,方便后續維護,現規范 git 的相關操作。

主要規范兩點:

git 分支命名規范

git 提交記錄規范

1. git 分支命名規范

git 分支分為集成分支、功能分支和修復分支,分別命名為 develop、feature 和 hotfix,均為單數。不可使用 featuresfuturehotfixeshotfixs 等錯誤名稱。

  • 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/ShaYeBlog/p/5575852.html


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM