1、为什么要使用code review
项目代码需要整个开发团队来维护,避免因为部分人代码质量不好,从而影响整个系统的的出错概率;保持团队的编码风格一致,方便后期维护;共同优化代码,可以提升自身的编码水平;可以过早弥补低级的代码错误引起的bug;相互学习,推动团队共同进步。
2、code review流程
1)根据开发任务,建立git分支,分支名称模式为:dev-版本-feature-功能名称,比如关于api相关的一项任务,建立分支:git checkout -b dev-v100-feature-api;
2)运行git branch 确认切换到了dev-v100-feature-api分支;
3)编辑代码完成开发任务,并提交:git add . && git commit -m "xxx";
4)将分支代码push到服务器:git push origin -u dev-v100-feature-api;
5)登录到gitee的源代码库,点击Pull request按钮去创建一个pull request, 如下图:
选择源分支和目标分支,说明信息以及审查人员,并完成创建:
6) 请提醒审查人员去审核pull request,审查人员在Pull Requests或者系统消息栏会收到提醒reviewer的消息;
7) 审查人员打开pull request页面,在“文件”区添加评论(点击或者拖动十字按钮添加评论),也可以查看之前所评论,以及提交的记录;
8)代码作者根据reviewer的要求,调整代码后commit/push到远程仓库。 然后审查人员继续评论, 如此循环,直到没有问题;
9)当审核通过后, 需要将任务代码merge到主代码库, 有两种方法:
a、审查人员可以在pull request页面点击Merge按钮, 把代码merge到主代码库
b、代码作者自己merge到主代码库, 并push到服务器。
10)代码作者删除feature子分支。
git branch -D dev-v100-feature-api
git push origin :dev-v100-feature-api