git规范

导读

为了避免歧义，文档大量使用了「能愿动词」，对应的解释如下：

必须（Must） - 只能这样子做，请无条件遵循，没有别的选项；

绝不（Must Not）- 严令禁止，在任何情况下都不能这样做；

应该（Should） - 强烈建议这样做，但是不强求；

不应该（Should Not） - 强烈建议不这样做，但是不强求；

可以（May） - 选择性高一点

参考：RFC 2119

branch

长期分支

master —— 主分支，同时也是线上最新代码的分支。
dev —— 开发人员的基础分支，所有的开发功能分支（feat）都需要从dev分支上进行拉取，同时也要合并到dev分支。
test —— 测试分支，需要将dev分支合并到测试分支，进行功能的测试，如果没有问题，再将dev分支合并到master上，进行新功能的上线。

短期分支

hotfixes —— 紧急分支，用于修改master分支上的错误，修改后必须将此分支合并到master和dev分支。
feature —— 功能分支，功能分支必须从dev分支切出，完成后提交pr，review后必须合并到dev。
fix —— bug分支，用与修改非生产环境出现的bug。

分支规范

feature分支

feature分支命名必须遵循feat-{yourname}/{featurename}#{towerid}或feature-{yourname}/{featurename}#{towerid}

hotfixes分支

hotfixes分支命名必须遵循hotfix-{yourname}/{hotfixname}

fix分支

fix分支命名必须遵循fix-{yourname}/{fixname}#{towerid}

*注：

yourname —— 姓名，如：songjian
featurename —— 功能分支名，如add-login
hotfixes —— 紧急分支名，如hotfix-user-cant-upload
fix —— bug分支名，如fix-user-cant-upload
towerid —— 对应的towerid，如果存在就写

commit

commit分类（可以使用，非强制性使用）

feat —— 功能，feat: 添加登陆功能
fix —— bug，fix: 修改登录接口错误
hotfix —— 紧急，hotfix: 修改生产环境登录接口错误
docs —— 文档，docs: 修改README
style —— 不影响代码含义的更改（空格、格式、缺少分号等）style: 删除空格，删除console
perf —— 提高性能的代码更改 perf: 优化打包后的文件大小
test —— 添加缺失测试或纠正现有测试 test: 添加对什么方法为0的单元测试
build —— 影响生成系统或外部依赖项的更改（示例范围：gulp、broccoli、npm）build: 修改webpack打包配置 / build: 添加js-cookies包
ci —— 对CI配置文件和脚本的更改 ci: 修改xxx.yaml文件
chore —— 其他不修改src或测试文件的更改，如在根目录下的其他文件 chore: 修改时间格式化函数
refactor —— 既不修复错误也不添加功能的代码更改 refactor: 添加.gitignore
revert —— 还原以前的提交 revert: #62

pull request

pr必须提交到dev分支，并由组长或项目管理人员进行review后没有问题进行合并
pr遇到冲突时，必须应该自己解决
pr可以简述功能信息

merge

dev分支

代码通过提交pr（同时写明信息）后，必须有至少一个人进行review，review后没有问题可以合并到dev分支
hotfix分支

代码应从master分支切出，修改完成后必须提交两个pr分别到master和dev，在reviewer审查没问题后合并到master和dev
fix分支

代码从dev分支切出，在修改完成后必须提交pr（同时写明信息）后，在reviewer审查没问题后合并到dev
feat分支

代码从dev分支切出，在功能完成后必须提交pr（同时写明信息）后，在reviewer审查没问题后合并到dev
test分支

代码必须从dev分支合并进来

注意事项

不能直接提交代码到master，dev，test分支
必须有一个reviewer
合并到master和test应由reviewer进行
除master，dev，test分支，其他所有分支应在使用完成后进行销毁删除

git规范

导读

branch

长期分支

短期分支

分支规范

feature分支

hotfixes分支

fix分支

commit

commit分类（可以使用，非强制性使用）

pull request

merge

tag

注意事项