Git代码管理规范

1. 简介

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)

2. 分支命名

a. master 分支

master 为主分支,也是用于部署生产环境的分支,需要确保master分支稳定性。master 分支一般由 release 以及 hotfix 分支合并,任何时间都不能直接修改代码。

b. develop 分支

develop 为开发环境分支,始终保持最新完成以及bug修复后的代码,用于前后端联调。一般开发的新功能时,feature分支都是基于develop分支创建的。

c. feature 分支

开发新功能时,以develop为基础创建feature分支。

分支命名时以 feature/ 开头,后面可以加上开发的功能模块, 命名示例:feature/user_module、feature/cart_module

d. test分支

test为测试环境分支,外部用户无法访问,专门给测试人员使用,版本相对稳定。

e. release分支

release 为预上线分支(预发布分支),UAT测试阶段使用。一般由 test 或 hotfix 分支合并,不建议直接在 release 分支上直接修改代码。

f. hotfix 分支

线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支。修复完成后,需要合并到 master 分支和 develop 分支。

分支命名以hotfix/ 开头的为修复分支,它的命名规则与 feature 分支类似。

3. 分支与环境

在系统开发过程中常用的环境:

DEV 环境(Development environment):用于开发者调试使用

FAT环境(Feature Acceptance Test environment):功能验收测试环境,用于测试环境下的软件测试者测试使用

UAT环境 (User Acceptance Test environment):用户验收测试环境,用于生产环境下的软件测试者测试使用

PRO 环境(Production environment):生产环境

对应关系:

分支

功能

环境

可访问

master

主分支,稳定版本

PRO

develop

开发分支,最新版本

DEV

feature

开发分支,实现新特性

test

测试分支,功能测试

FAT

release

预上线分支,发布新版本

UAT

hotfix

紧急修复分支,修复线上bug

分支合并流程规范

业界常见的两大主分支(master、develop)、三个辅助分支(feature、release、hotfix)的生命周期:

以上生命周期仅作参考,不同开发团队可能有不同的规范,可自行灵活定义。

例如部分团队在开发时,至少需要保证以下流程:

develop 分支和 hotfix 分支,必须从 master 分支检出

由 develop 分支合并到 test 分支

功能测试无误后,由 test 分支合并到 release 分支

UAT测试通过后,由 release 分支合并到 master分支

对于工作量小的功能开发(工时小于1天),可以直接在devolop 分支进行开发,否则由 develop 分支检出 feature 分支进行开发,开发完后合并到develop 分支

4. Git Commit Message规范

Git commit message规范指提交代码时编写的规范注释,编写良好的Commit messages可以达到3个重要的目的:

  • 加快代码review的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和feature被添加的原因

Angular Git Commit Guidelines

业界应用的比较广泛的是Angular Git Commit Guidelines:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • type:提交类型
  • scope:可选项,本次 commit 波及的范围
  • subject:简明扼要的阐述下本次 commit 的主旨,在Angular Git Commit Guidelines中强调了三点。使用祈使句,首字母不要大写,结尾无需添加标点
  • body: 同样使用祈使句,在主体内容中我们需要把本次 commit 详细的描述一下,比如此次变更的动机
  • footer: 描述下与之关联的 issue 或 break change

简易版

项目中实际可以采用简易版规范:

<type>(<scope>):<subject>

type规范

Angular Git Commit Guidelines中推荐的type类型如下:

feat: 新增功能

fix: 修复bug

docs: 仅文档更改

style: 不影响代码含义的更改(空白、格式设置、缺失 分号等)

refactor: 既不修复bug也不添加特性的代码更改

perf: 改进性能的代码更改

test: 添加缺少的测试或更正现有测试

chore: 对构建过程或辅助工具和库(如文档)的更改

除此之外,还有一些常用的类型:

delete:删除功能或文件

modify:修改功能

build:改变构建流程,新增依赖库、工具等(例如webpack、gulp、npm修改)

test:测试用例的新增、修改

ci:自动化流程配置修改

revert:回滚到上一个版本

单次提交注意事项:

提交问题必须为同一类别

提交问题不要超过3个

提交的commit发现不符合规范,git commit --amend -m "新的提交信息"或 git reset --hard HEAD 重新提交一次

5. .gitignore文件

.gitignore是一份用于忽略不必提交的文件的列表,项目中可以根据实际需求统一.gitignore文件,减少不必要的文件提交和冲突,净化代码库环境。

通用文件示例:

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

6. 其他

此外,还有一些其他建议:

  • master 分支的每一次更新,都建议打 tag 添加标签,通常为对应版本号,便于管理
  • feature分支、hotfix分支在合并后可以删除,避免分支过多管理混乱
  • 每次 pull 代码前,提交本地代码到本地库中,否则可能回出现合并代码出错,导致代码丢失
  • 26
    点赞
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
git 代码管理规范通常包括以下几个方面: 1. 分支管理:使用合适的分支策略,例如主分支(master/main)、开发分支(develop)、功能分支(feature)、修复分支(hotfix)等。确保每个分支的作用清晰,遵循分支的创建、合并和删除规则。 2. 提交规范:每次提交都应该有明确的目的和描述,使用有意义的提交消息,以便其他人能够理解代码变更的目的。可以使用规范化的提交消息格式,如 Conventional Commits。 3. 代码审查:进行代码审查是保证代码质量和团队合作的重要环节。确保每个代码变更都经过审查,并及时给予反馈和建议。 4. 版本标签:在代码达到一个重要里程碑或版本发布时,使用版本标签进行标记。这有助于团队成员快速定位和使用特定版本的代码。 5. 冲突解决:当多人同时修改同一文件或同一部分代码时,可能会发生冲突。在解决冲突时,应及时与相关人员协商并选择合适的解决方案。 6. 忽略文件:在项目中使用.gitignore文件,忽略不需要版本控制的文件和文件夹,如临时文件、日志文件等。 7. 规范化命名:代码文件、变量、函数、类等的命名应清晰、一致,并符合项目的命名约定或规范。 8. 文档管理:在代码中添加必要的注释,并编写清晰易懂的文档,包括项目说明、API文档、使用说明等,以便团队成员理解和使用代码。 以上是一些常见的git代码管理规范,具体的规范可以根据团队的需求和项目的特点进行适当调整和补充。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值