git 分支管理规范

98 阅读2分钟

分支命名和提交信息规范说明,也是大多数公司采用的方式。采用统一规范,可以使代码管理、维护更方便、具有良好的可读性和操作性。

分支规范

分支采用类型方式进行命名,如功能开发 feat,解决问题 fix,其他相关请参照下表。分支命名需要采用路径方式如开发了购物车功能,分支名 feat/cart,解决购物车 bug 分支名 fix/cart 等,这样看到分支名可以知道这个分支作用。

分支类型分支说明备注
feat新功能(feature)feat/cart
fix修补 bugfix/cart
docs文档(documentation)
style格式不影响代码运行的变动
test增加测试
refactor重构即不是新增功能,也不是修改 bug 的代码变动
chore构建过程或辅助工具的变动
upgrade更新,升级版本等不常用
perf性能优化逻辑优化等

分支名分支说明(需求说明)
master线上分支
dev测试分支
feat/1.1.x功能迭代一
feat/1.2.x功能迭代二
feat/1.3.x功能迭代三
fix/1.1.x修复 bug
fix/1.2.x修复 bug

commit 规范

分支以类型创建, 功能 branchType/versionNum 当前功能对应的版本,开发合并到 master 后, 验证通过后删除分支, 并打上 tag,格式 ( v + versionNum )

commit 信息类型commit 信息说明备注
feat新功能feat:购物车模块开发
fix修补 bug(主要是针对功能开发)fix:购物车模块接口字段 bug 修复
docs文档(功能、特殊说明等)docs:新增购物车模块文档说明
style格式style:不影响代码运行的变动
test增加测试test:增加单元测试代码
refactor重构, 不是新增功能,也不是修改 bug 的代码变动refactor:重构购物车代码逻辑
chore构建过程或辅助工具的变动chore:增加目录
upgrade更新,升级版本等upgrade:升级版本
pref性能提升的修改
build对项目构建或者依赖的改动

⚠️ 在实际开发中,将各个分支的情况说明记录在 README.md 文档中,以备查阅。