GIT 開發規範

2022-04-10 18:16:47 字數 1446 閱讀 9275

git 是目前用得最多的也是最好用的合作開發工具。記得最開始工作的時候由於 git 用的很不熟練導致增加了很多任務作量,關於 git 的使用教程網上有很多,這裡記一下乙個完整的使用 git 進行合作開發的體系。

合理利用分支的命名可以更高效的進行**的管理,乙個合理的多人開發的專案,分支主要根據場景進行命名。

主要的分支為:master 、develop (dev)、release 、hotfix(bug)

完整的流程:

專案會有乙個 master 分支,用於線上執行。dev 分支,用於測試環境執行。

當有新功能需求時,以 develop 為基礎根據需求建立 feature 分支,如增加許可權驗證:feature/add_auth,開發自測完成後合併入 dev 分支

進入提測階段,以 dev 分支為基礎建立 release 分支,如果測試過程中若存在 bug 需要修復,則直接由開發者在 release 分支修復並提交。當測試完成之後,合併 release 分支到 develop 分支,合併 develop 分支到 master 分支。此時master為最新**,用作上線。

若某時發現系統存在 bug,需要及時修復,以 master 分支為基礎建立 hotfix 分支,修復完成後,需要合併到 master 分支和 develop 分支。

在乙個團隊協作的專案中,開發人員需要經常提交一些**去修復 bug 或者實現新的 feature。而專案中的檔案和實現什麼功能、解決什麼問題都會漸漸淡忘,最後需要浪費時間去閱讀**。但是好的日誌規範 commit messages 編寫有幫助到我們,它也反映了乙個開發人員是否是良好的協作者。

commit messages的基本語法

當前業界應用的比較廣泛的是 angular git commit guidelines。

:
type: 本次 commit 的型別,諸如 bugfix、 docs、 style 等

scope: 本次 commit 波及的範圍

使用祈使句

首字母不要大寫

結尾無需新增標點

body: 同樣使用祈使句,在主體內容中我們需要把本次 commit 詳細的描述一下,比如此次變更的動機,如需換行,則使用 |

footer: 描述下與之關聯的 issue 或 break change

# 標題行:50個字元以內,描述主要變更內容

## 主體內容:更詳細的說明文字,建議72個字元以內。 需要描述的資訊包括:

## * 為什麼這個變更是必須的?它可能是用來修復乙個bug,增加乙個feature,提公升效能、可靠性、穩定性等等

# * 他如何解決這個問題?具體描述解決問題的步驟

# * 是否存在***、風險?#

範例參考:

git 分支開發規範

git 進行 管理和開發時,分支的管理也是非常必要的 1 master分支 部署生產環境的分支,這個分支只能從其他分支合併,如develop release hotfix,不能在這個分支直接修改 2 develop分支 我們的主開發分支,是乙個穩定的版本,通常由release分支合併過來,通常發到s...

Git分支Git Flow開發規範

規範化管理 庫分支有助於版本庫在演進過程中始終保持簡潔,主幹結構清晰。各個分支各司其職,有利於後續的維護更新,避免版本發布帶來的混亂問題。a successful git branching model git官方文件 branching workflows 以下為git分支開發規範的簡單總結 ma...

Git分支模型和開發規範詳解

1.分支管理 1.1 總覽 從上圖可以看到主要包含下面幾個分支 master 主分支,主要用來版本發布。develop 日常開發分支,該分支正常儲存了開發的最新 feature 從develop分支fork,合併回develop。具體的功能開發分支。release 從develop分支fork,合併...