Gitlab 合作开发流程(新人向)

后端接口开发流程和规范

总的来说就是先把项目code clone到本地,然后修改部分配置文件后本地run起来;接着创建新的分支,在新分支上进行功能接口的开发,开发完成后本地用postman进行测试,测试通过后commit,并把进行分支merge,push后发起merge request,给mentor(reviewer) review代码,通过后完成项目开发。如果是接口修改,还需要在接口文档中@相关的前端人员等进行说明。

1.代码clone

首先在gitlab找到代码库,切换develop分支后clone到本地

git clone xxxx

2.yml文件配置修改

修改yml文件配置,如spring.profiles.active和bootstrap切换配置文件名,spring.cloud.nacos.discovery.enabled和spring.cloud.nacos.config.enabled设置为false(常见)

3.项目启动

把项目在本地跑起来

4.项目开发

4.1.新建新的分支

不允许在develop分支上直接开发,需要新建一个分支,分支命名通常为dev_f_xxxx(xxxx是项目编号)
ps:项目编号一般可以在飞书等平台上找到

4.2.切换到新的分支进行开发

在新的分支上开发

4.3.接口测试

用postman对开发完毕的接口进行功能测试

4.4.代码commit

将修改后的代码commit,commit内容模板通常为:

1
2
3
项目名称-项目编号-2001 mod/add/del/ref  
**(空一行)**
内容,通常是描述做的操作

ps:yml配置文件通常不允许commit
不要在一次commit里提交大量的变更,做到少量多次

4.5.更新develop

切换到develop分支,执行git pull操作,将远端最新的代码拉到本地

4.6.merge分支

再切换到dev_f_xxxx分支,将develop分支merge到本分支,有冲突本地解决

4.7.发起merge request

把自己的分支dev_f_xxx push到远端后,在gitLab上提交merge request把dev_f_xxx合并到develop分支,assign给reviewer

5.流程结束


Gitlab 合作开发流程(新人向)
https://shouldbeldy.github.io/2023/01/06/Gitlab-合作开发流程(新人向)/
作者
Daoyu Lei
发布于
2023年1月6日
许可协议