跳到主要内容

使用 PullRequest 功能进行代码审查

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

    1. 仓库管理员 设置代码审查。 设置指定人员为某仓库默认的代码审核/测试人员后，每当有新的 Pull Request 以此仓库内分支为目标分支时，系统会通知指定人员前去审查提交的 Pull Request（也就是改动的代码内容），同时也可以设置合并 Pull Request 的门槛（例如是否需要全部指定人员同意才可以合并）。
    1. 开发者 提交 Pull Request。 开发者通过 Fork 仓库的分支向源仓库的分支 或 同仓库内的工作分支向源分支 提交 Pull Request 的方式来发起一个代码审查的请求，以达到更新源分支的代码的目的。
    1. 审查者 进行代码审核/测试。 指定人员查看开发者提交的 Pull Request 内容，并决定是否同意接受该开发者的改动。
    1. 仓库管理员 合并 Pull Request。 仓库的管理人员在审查者同意后，即可通过合并 Pull Request 的方式把开发者的文件改动内容同步到源分支。

图示如下：

输入图片说明

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

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

  2. 根据需求设置相应的代码审核/测试人员。 输入图片说明 设置完成后，每当有开发者向仓库内的分支提交 Pull Request，相关人员即可收到通知，开始代码审查流程。

2. 开发者 提交 Pull Request​

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

  2. 系统会默认对应源分支和要修改的目标分支 输入图片说明

  3. 填入 Pull Request 的说明，点击“创建”，就可以提交一个 Pull Request： 输入图片说明

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

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

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

  2. 审查者可以查看 Pull Request 详情 输入图片说明

  3. 在“评论”中留下自己对这个 Pull Request 中改动的意见和建议 输入图片说明

  4. 同时支持“文件改动”中对代码行注释 输入图片说明

  5. 在“缺陷报告”和“规范报告”中查看报告内容 输入图片说明

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

4. 仓库管理员 合并 Pull Request​

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

输入图片说明

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