Git代码规范

惊落一身雪 · 2025-1-17 06:51:18

马上注册，结交更多好友，享用更多功能，让你轻松玩转社区。

您需要登录才可以下载或查看，没有账号？立即注册

x

分支命名

master 分支

master 为主分支，也是用于部署生产情况的分支，必要确保master分支稳定性。master 分支一样平常由 release 以及 hotfix 分支归并，任何时间都不能直接修改代码。
develop 分支

develop 为开辟情况分支，始终保持最新完成以及bug修复后的代码，用于前后端联调。一样平常开辟的新功能时，feature分支都是基于develop分支创建的。
feature 分支

开辟新功能时，以develop为底子创建feature分支。
分支命名时以 feature/ 开头，背面可以加上开辟的功能模块，命名示例：feature/user_module、feature/cart_module
test分支

test为测试情况分支，外部用户无法访问，专门给测试人员利用，版本相对稳定。
release分支

release 为预上线分支（预发布分支），UAT测试阶段利用。一样平常由 test 或 hotfix 分支归并，不建议直接在 release 分支上直接修改代码。
hotfix 分支

线上出现紧急问题时，必要实时修复，以master分支为基线，创建hotfix分支。修复完成后，必要归并到 master 分支和 develop 分支。
分支命名以hotfix/ 开头的为修复分支，它的命名规则与 feature 分支雷同。
分支与情况对应关系

在体系开辟过程中常用的情况：

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 分支

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 重新提交一次

配置.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

复制代码

其他

此外，还有一些其他建议：

master 分支的每一次更新，都建议打 tag 添加标签，通常为对应版本号，便于管理
feature分支、hotfix分支在归并后可以删除，制止分支过多管理混乱
每次 pull 代码前，提交当地代码到当地库中，否则大概回出现归并代码堕落，导致代码丢失

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

		自动登录	找回密码
密码			立即注册

Git代码规范

马上注册，结交更多好友，享用更多功能，让你轻松玩转社区。

0 个回复

快速回复

楼主热帖

标签云

浏览过的版块