审查 Pull Request#

使用工作流程特性#

在审查 pull requests 时,请根据需要在 Github 上使用工作流程跟踪功能

  1. 在完成审查后,并希望要求提交者进行更改

    • 将您的审查状态更改为“需要更改”。

      这可以在 Github 上完成,PR 页面,Files changed 选项卡,Review changes (右上角的按钮)。

    • 或者:添加 needs-work 标签。

      这可以在 PR 页面,右侧的 Labels 菜单中完成。

  2. 当您再次重新审查同一个 pull request 时,并希望要求更多更改

    • 再次执行“需要更改”操作,即使之前的状态也是“需要更改”。

    • 或者:删除现有的 needs-work 标签,然后再次重新添加该标签。(Github 将在页面上添加您已执行此操作的通知。)

  3. 如果您对当前状态感到满意

    • 将 pull request 标记为已批准(与“需要更改”的方式相同)。

    • 或者:删除 needs-work 标签。

    • 或者(对于核心开发者):如果您认为 pull request 已准备好合并,则合并它。

这允许自动跟踪哪些 PR 需要关注。

某些信息也可以直接在 Github 上看到,尽管(截至 2019 年 8 月)Github 不显示自上次审查以来哪些 pull requests 已更新。

来自 pull request 的代码#

当您审查其他人创建的 pull request 时,最好在您自己的机器上拥有他们的代码副本,以便您可以在本地使用它。

一种方法是安装 GitHub CLI,然后在终端中导航到 SciPy 根目录并输入

gh pr checkout PULL_REQUEST_ID

其中 PULL_REQUEST_ID 是与 pull request 对应的五位数数字(例如,10286 对应于 PR #10286)。这会立即将 pull request 检出到与 PR 作者使用的名称匹配的分支中。

假设您按照 从源码构建 设置了您的开发环境,您现在可以激活您的开发环境

conda activate scipy-dev

构建代码并进行测试

python dev.py test -v

并且如果您从 IPython 中 import SciPy(使用 python dev.py ipython 启动它),您将导入作者修改后的 SciPy 版本。

如果您想与作者协作处理他们的 PR,您可能希望为作者的 SciPy 分支设置一个新的远程

git remote add REMOTE_NAME https://github.com/AUTHOR/scipy.git

其中 AUTHOR 是作者的 GitHub 用户名,REMOTE_NAME 是您要用于引用此作者存储库的任何名称。

从那里,您可以查看作者的分支

git remote show REMOTE_NAME

并基于其中一个分支创建您自己的分支

git checkout --track REMOTE_NAME/BRANCH_NAME

其中 BRANCH_NAME 是您要从中启动的分支的名称。这将在您的本地存储库中创建此分支的副本(具有相同的名称)。如果您对此分支进行更改并推送到您的 GitHub 存储库(origin),则您可以创建一个 pull request,以将您的更改与作者的存储库合并。