大廠(chǎng)都在用的Git代碼管理規(guī)范
分支命名
master 分支
master 為主分支,也是用于部署生產(chǎn)環(huán)境的分支,需要確保master分支穩(wěn)定性。master 分支一般由 release 以及 hotfix 分支合并,任何時(shí)間都不能直接修改代碼。
develop 分支
develop 為開(kāi)發(fā)環(huán)境分支,始終保持最新完成以及bug修復(fù)后的代碼,用于前后端聯(lián)調(diào)。一般開(kāi)發(fā)的新功能時(shí),feature分支都是基于develop分支創(chuàng)建的。
feature 分支
開(kāi)發(fā)新功能時(shí),以develop為基礎(chǔ)創(chuàng)建feature分支。
分支命名時(shí)以 feature/ 開(kāi)頭,后面可以加上開(kāi)發(fā)的功能模塊, 命名示例:feature/user_module、feature/cart_module
test分支
test為測(cè)試環(huán)境分支,外部用戶(hù)無(wú)法訪(fǎng)問(wèn),專(zhuān)門(mén)給測(cè)試人員使用,版本相對(duì)穩(wěn)定。
release分支
release 為預(yù)上線(xiàn)分支(預(yù)發(fā)布分支),UAT測(cè)試階段使用。一般由 test 或 hotfix 分支合并,不建議直接在 release 分支上直接修改代碼。
hotfix 分支
線(xiàn)上出現(xiàn)緊急問(wèn)題時(shí),需要及時(shí)修復(fù),以master分支為基線(xiàn),創(chuàng)建hotfix分支。修復(fù)完成后,需要合并到 master 分支和 develop 分支。
分支命名以hotfix/ 開(kāi)頭的為修復(fù)分支,它的命名規(guī)則與 feature 分支類(lèi)似。
分支與環(huán)境對(duì)應(yīng)關(guān)系
在系統(tǒng)開(kāi)發(fā)過(guò)程中常用的環(huán)境:
- DEV 環(huán)境(Development environment):用于開(kāi)發(fā)者調(diào)試使用
- FAT環(huán)境(Feature Acceptance Test environment):功能驗(yàn)收測(cè)試環(huán)境,用于測(cè)試環(huán)境下的軟件測(cè)試者測(cè)試使用
- UAT環(huán)境 (User Acceptance Test environment):用戶(hù)驗(yàn)收測(cè)試環(huán)境,用于生產(chǎn)環(huán)境下的軟件測(cè)試者測(cè)試使用
- PRO 環(huán)境(Production environment):生產(chǎn)環(huán)境
對(duì)應(yīng)關(guān)系:
分支 | 功能 | 環(huán)境 | 可訪(fǎng)問(wèn) |
master | 主分支,穩(wěn)定版本 | PRO | 是 |
develop | 開(kāi)發(fā)分支,最新版本 | DEV | 是 |
feature | 開(kāi)發(fā)分支,實(shí)現(xiàn)新特性 | 否 | |
test | 測(cè)試分支,功能測(cè)試 | FAT | 是 |
release | 預(yù)上線(xiàn)分支,發(fā)布新版本 | UAT | 是 |
hotfix | 緊急修復(fù)分支,修復(fù)線(xiàn)上bug | 否 |
分支合并流程規(guī)范
業(yè)界常見(jiàn)的兩大主分支(master、develop)、三個(gè)輔助分支(feature、release、hotfix)的生命周期:
圖片
以上生命周期僅作參考,不同開(kāi)發(fā)團(tuán)隊(duì)可能有不同的規(guī)范,可自行靈活定義。
例如我們團(tuán)隊(duì)在開(kāi)發(fā)時(shí),至少需要保證以下流程:
- develop 分支和 hotfix 分支,必須從 master 分支檢出
- 由 develop 分支合并到 test 分支
- 功能測(cè)試無(wú)誤后,由 test 分支合并到 release 分支
- UAT測(cè)試通過(guò)后,由 release 分支合并到 master分支
- 對(duì)于工作量小的功能開(kāi)發(fā)(工時(shí)小于1天),可以直接在devolop 分支進(jìn)行開(kāi)發(fā),否則由 develop 分支檢出 feature 分支進(jìn)行開(kāi)發(fā),開(kāi)發(fā)完后合并到develop 分支
Git Commit Message規(guī)范
Git commit message規(guī)范指提交代碼時(shí)編寫(xiě)的規(guī)范注釋?zhuān)帉?xiě)良好的Commit messages可以達(dá)到3個(gè)重要的目的:
- 加快代碼review的流程
- 幫助我們編寫(xiě)良好的版本發(fā)布日志
- 讓之后的維護(hù)者了解代碼里出現(xiàn)特定變化和feature被添加的原因
Angular Git Commit Guidelines
業(yè)界應(yīng)用的比較廣泛的是Angular Git Commit Guidelines:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
- type:提交類(lèi)型
- scope:可選項(xiàng),本次 commit 波及的范圍
- subject:簡(jiǎn)明扼要的闡述下本次 commit 的主旨,在Angular Git Commit Guidelines中強(qiáng)調(diào)了三點(diǎn)。使用祈使句,首字母不要大寫(xiě),結(jié)尾無(wú)需添加標(biāo)點(diǎn)
- body: 同樣使用祈使句,在主體內(nèi)容中我們需要把本次 commit 詳細(xì)的描述一下,比如此次變更的動(dòng)機(jī)
- footer: 描述下與之關(guān)聯(lián)的 issue 或 break change
簡(jiǎn)易版
項(xiàng)目中實(shí)際可以采用簡(jiǎn)易版規(guī)范:
<type>(<scope>):<subject>
type規(guī)范
Angular Git Commit Guidelines中推薦的type類(lèi)型如下:
- feat: 新增功能
- fix: 修復(fù)bug
- docs: 僅文檔更改
- style: 不影響代碼含義的更改(空白、格式設(shè)置、缺失 分號(hào)等)
- refactor: 既不修復(fù)bug也不添加特性的代碼更改
- perf: 改進(jìn)性能的代碼更改
- test: 添加缺少的測(cè)試或更正現(xiàn)有測(cè)試
- chore: 對(duì)構(gòu)建過(guò)程或輔助工具和庫(kù)(如文檔)的更改
除此之外,還有一些常用的類(lèi)型:
- delete:刪除功能或文件
- modify:修改功能
- build:改變構(gòu)建流程,新增依賴(lài)庫(kù)、工具等(例如webpack、gulp、npm修改)
- test:測(cè)試用例的新增、修改
- ci:自動(dòng)化流程配置修改
- revert:回滾到上一個(gè)版本
單次提交注意事項(xiàng)
- 提交問(wèn)題必須為同一類(lèi)別
- 提交問(wèn)題不要超過(guò)3個(gè)
- 提交的commit發(fā)現(xiàn)不符合規(guī)范,git commit --amend -m "新的提交信息"或 git reset --hard HEAD 重新提交一次
配置.gitignore文件
.gitignore是一份用于忽略不必提交的文件的列表,項(xiàng)目中可以根據(jù)實(shí)際需求統(tǒng)一.gitignore文件,減少不必要的文件提交和沖突,凈化代碼庫(kù)環(huán)境。
通用文件示例:
HELP.md
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
!**/src/test/**/target/
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
build/
!**/src/main/**/build/
!**/src/test/**/build/
### VS Code ###
.vscode/
# Log file
*.log
/logs*
# BlueJ files
*.ctxt
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.zip
*.tar.gz
*.rar
*.cmd
其他
此外,還有一些其他建議:
- master 分支的每一次更新,都建議打 tag 添加標(biāo)簽,通常為對(duì)應(yīng)版本號(hào),便于管理
- feature分支、hotfix分支在合并后可以刪除,避免分支過(guò)多管理混亂
- 每次 pull 代碼前,提交本地代碼到本地庫(kù)中,否則可能回出現(xiàn)合并代碼出錯(cuò),導(dǎo)致代碼丟失