我如何审查 GitHub PRs

主要观点:作者从管理岗位转回 IC 角色后,重新学习代码审查相关事宜,包括使用 GitHub 进行大型 PR 审查时遇到的问题及解决方法,如本地获取变更、使用git reset --mixed、分阶段审查、在代码中保留注释、使用单独的 Git 工作树等,并提出未来可改进的方向。
关键信息:

  • 工作地倾向大的 PR,作者许久未进行此类审查,GitHub 在该方面有改进但仍有不足,如标记文件和块、写注释等。
  • 本地获取 PR 变更的方法:使用 GitHub CLI 工具gh co <PR 编号>,或用git reset --mixed main将变更留在工作副本中以便查看和操作。
  • 可通过git add -p等工具分阶段审查,在编辑器中显示不同状态的变更。
  • 建议在代码中保留注释,分为// REVIEW(bmps)// NOTE(bmps),审查结束后手动将// REVIEW(bmps)复制到 GitHub。
  • 使用git worktree add -d../foobar-reviews创建专门的 Git 工作树用于审查,避免与正在进行的代码冲突。
  • 目前流程存在的不足:难以在审查过程中本地保留注释、处理上游变更时易产生合并冲突、无法方便查看他人的评论等。
    重要细节:
  • 作者有一个fish函数revpr用于检查和审查 PR。
  • git reset --mixed origin/main需先git fetch,否则可能出现问题。
  • prr工具虽能解决部分问题但不符合作者需求。
  • Visual Studio Code 的 GitHub 扩展可在编辑器中显示 GitHub 评论,但作者使用 Helix 和 PhpStorm 编辑器,更倾向通用的工作流程。
阅读 14
0 条评论