Git规范
Git规范
目标与原则
目标
- 分支职责清晰,避免混乱
- 提交记录可读、可追溯、可回滚
- 支持多人并行开发、快速发布与问题回溯
基本原则
- 一个分支只做一类事情
- 一个提交只解决一个问题
-
提交信息能“脱离上下文”被理解
- 永远不要直接在main/master/dev分支上开发
- 永远不要将dev分支的代码合并到自己的功能分支上
分支模型
主干分支(长期存在)
| 分支名 | 说明 | 是否允许直接提交 |
|---|---|---|
| main/master | 线上稳定分支 | ❌ |
| dev | 测试环境分支 | ❌ |
永远不要在主干分支上进行开发
功能与辅助分支(临时)
| 类型 | 命名方式 | 示例 | 规则 |
|---|---|---|---|
| 功能分支 | feat/<功能说明> |
feat/hero feat/bag feat/gift-mall |
基于master切出分支 合并到dev分支到测试环境验证 合并到master分支发布到线上 合并到master后删除分支 |
| 修复分支 | fix/<问题说明> |
fix/hero-upgrade fix/bag-give-reward |
基于master切出分支 合并到dev分支到测试环境验证 合并到master分支发布到线上 合并到master后删除分支 |
Master ——— MR———》 feat/branch 《———- MR———— dev
提交规范
Commit Message格式
1
<type>(<scope>): <subject>
示例:
- feat(hero): upgrade hero skills
- fix(battle): damage calculation error
类型说明
| 类型 | 说明 |
|---|---|
| feat | 新功能 |
| fix | bug修复 |
| refactor | 重构(无功能变化) |
| perf | 性能优化 |
| docs | 文档 |
| test | 测试 |
| chore | 构建、工具、杂项 |
| style | 格式调整(不影响逻辑) |
This post is licensed under
CC BY 4.0
by the author.