my collection
    Gitee Support Center / detail

    使用Pull Request 功能进行代码审查

    如果你的团队采用了码云推荐的“Fork + Pull”协作模式,我们同时推荐通过Pull Request这个功能来进行团队中的代码审查,有如下步骤:

    1、仓库管理员 设置代码审查。

    设置指定人员为某仓库默认的代码审核/测试人员后,每当有新的Pull Request以此仓库内分支为目标分支时,系统会通知指定人员前去审查提交的Pull Request(也就是改动的代码内容),同时也可以设置合并Pull Request的门槛(例如是否需要全部指定人员同意才可以合并)。

    2、开发者 提交Pull Request。

    开发者通过 Fork仓库的分支向源仓库的分支 或 同仓库内的工作分支向源分支 提交Pull Request的方式来发起一个代码审查的请求,以达到更新源分支的代码的目的。

    3、审查者 进行代码审核/测试。

    指定人员查看开发者提交的Pull Request内容,并决定是否同意接受该开发者的改动。

    4、仓库管理员 合并 Pull Request。

    仓库的管理人员在审查者同意后,即可通过合并Pull Request的方式把开发者的文件改动内容同步到源分支。

    图示如下:
    输入图片说明

    1、仓库管理员 设置代码审查

    1. 代码审查以仓库为单位。仓库管理员以上的成员可以进入【仓库详情】- 【代码审查设置】页面

    输入图片说明

    1. 根据需求设置相应的代码审核/测试人员。

    输入图片说明

    设置完成后,每当有开发者向仓库内的分支提交 Pull Request,相关人员即可收到通知,开始代码审查流程。

    2、开发者 提交 Pull Request

    1. 开发者Fork目标仓库,在对应分支上修改后,推送到自己Fork的仓库里,从自己仓库中点击“+ Pull Request”。

    输入图片说明

    1. 系统会默认对应源分支和要修改的目标分支

    输入图片说明

    1. 填入Pull Request的说明,点击“创建”,就可以提交一个Pull Request:

    输入图片说明

    3、审查者 进行代码审核/测试

    1. 在指定审查者的企业视图【工作台】- 【Pull Request】中,【指派给我的】那个tab即是该审查者需要进行代码审查的Pull Request。

    输入图片说明

    注:付费企业用户默认开启代码缺陷扫描,会自动扫描任何提交过来的Pull Request中的缺陷和规范问题。

    1. 审查者可以查看Pull Request详情

    输入图片说明

    1. 在“评论”中留下自己对这个Pull Request中改动的意见和建议

    输入图片说明

    1. 同时支持“文件改动”中对代码行注释

    输入图片说明

    1. 在“缺陷报告”和“规范报告”中查看报告内容

    输入图片说明

    审查者的建议会通过站内信等方式通知提交Pull Request的开发者,开发者可以根据情况在“评论”中与审查者进行讨论。

    4、仓库管理员 合并 Pull Request

    ​ Pull Request审查完成且满足仓库管理员设置的代码审查规则后,拥有合并Pull Request权限的成员(通常为仓库管理员,特殊情况请查看保护分支规则)即可把这个Pull Request合并到目标分支。

    输入图片说明

    合并完成后,开发者对目标分支的改动就生效了。如果出现其他异常问题,请参考如何进行版本回退

    Does this help you?

    Search