Skip to main content

审查你提出的更改

在合并前先检查自己的拉取请求,以便发现缺陷并提高质量,还可选择使用来自 Copilot 的 AI 辅助。

拉取请求让你有机会在它成为 main 的一部分之前,以全新的视角审视自己的工作。 在本教程中,你将查看自己的更改、应用改进并合并网站的第一项功能。

先决条件

  • 您的 add-starred-list 分支有一个未关闭的拉取请求。 如果尚未打开一个,请参阅 编写和存储代码

为什么查看代码?

在合并之前审查更改,有助于你在对这项工作记忆犹新时发现 bug、找出遗漏的错误处理,并提高可读性。 即使单独工作,故意审查也会构建一种习惯,使软件项目保持正常运行,并使以后协作更加轻松。

查看拉取请求中的更改

在 GitHub 上的拉取请求中,文件更改 选项卡会显示你的分支添加或修改的所有内容的差异。 仔细检查。

  1. 单击“查看你的拉取请求”以前往 GitHub 上的拉取请求收件箱。 或者,转到您的 stargazers-log 存储库,然后单击 拉取请求 选项卡。
  2. 单击标题以打开针对 add-starred-list 分支的拉取请求。
  3. 单击“已更改的文件”选项卡。
  4. 查看每个文件的差异,查找以下内容:
    • 缺陷或逻辑错误,例如 script.js 中的文件名不匹配。
    • 缺少错误处理机制,例如如果 events.json 加载失败,会发生什么。
    • 辅助功能问题,例如缺少文本替代项或不清楚的标签。
    • 任何可能让未来读者难以理解的不清楚之处。
  5. 若要记下要更改的内容,请将鼠标悬停在行上,单击 ,键入批注,然后单击“ 批注”。

可选:获取 AI 第二意见

还可以在编辑器中要求 副驾驶聊天 查看相同的更改并提供第二个视角。

  1. 在编辑器中,打开 副驾驶聊天。

  2. 让它使用如下提示来审查你的更改。

    Text
    Review my changes for bugs, missing error handling, and accessibility issues.
    
  3. 阅读这些建议,并决定哪些建议可以改进你的功能。 你始终可以决定进行哪些更改。

提示

如果你喜欢使用 Copilot 审查自己的代码,则可以订阅付费套餐,以获得额外的 AI 额度和 Copilot 代码评审;当你将 Copilot 添加为审查者时,它还会自动审查你的拉取请求。

有关详细信息,请参阅文档中 和 GitHub Enterprise Cloud。

应用反馈

将你的审阅备注以及你认同的任何 副驾驶聊天 建议整理成更新内容。

  1. 在编辑器中,更新受影响的文件以解决找到的内容。
  2. 在 GitHub Desktop中,输入提交消息,例如 Address review feedback,然后单击 “提交#”文件以添加星号列表
  3. 单击 Push origin 以用新的提交更新拉取请求。

合并拉取请求

确认所做更改无误后,将其合并到 main

  1. 打开 GitHub后,返回到拉取请求并刷新页面。
  2. 单击“ 对话 ”选项卡。
  3. 单击“ 合并拉取请求”,然后单击“ 确认合并”。
  4. 单击“ 删除分支 ”以清理 add-starred-list 分支。

正在检查你的进度

更新项目板以反映已完成的工作。

  1. 打开GitHub,从存储库中的Stargazers log”选项卡导航到**** 项目板。
  2. Display a list of starred repositories 项从 “正在进行” 拖动到 “完成”。

如果有更多的功能要生成,请创建新问题,并在下一个周期开始时将它们移动到 “正在进行 中”。

完整的工作流

现在,你已经完成了整个开发者工作流程:

  • 使用议题和项目看板规划工作。
  • 创建了分支并开发了你的功能。
  • 创建了拉取请求。
  • 审查了自己的更改(也可在 Copilot 的帮助下进行)。
  • 已将你的功能合并到 main 中。
  • 更新了项目板以反映进度。

你完成的工作

任务结果
已在“文件变更”选项卡中查看更改你已打开拉取请求的“文件已更改”选项卡并查看了差异。
已应用反馈,并获得可选的 AI 辅助你应用了更改,并可能要求 副驾驶聊天 进行评审。
合并了功能你已将你的更改合并到 main
已更新你的进度你已将该议题移动到你的项目看板上的 “已完成”

后续步骤