帮助他人审查您的更改 - GitHub 文档

当您创建拉取请求时，您是在请求团队审查您的更改并提供反馈。本指南提供创建易于审查且让团队保持了解的拉取请求的最佳实践，从而提升协作和审查质量。

让您的更改易于审查

在拉取请求中提供清晰的上下文可帮助审查者快速了解您更改了什么以及为何重要。这会让审查过程更快更顺畅，来回沟通更少，并帮助团队提供更好的反馈并作出自信的决定。有关创建拉取请求的信息，请参阅创建拉取请求。

目标是创建小而专注的拉取请求，完成单一目的。小型拉取请求更易且更快审查和合并，减少引入缺陷的空间，并提供更清晰的变更历史。

为您的拉取请求撰写清晰的标题和描述，使审查者能够快速了解拉取请求的作用。在拉取请求正文中，包括

为帮助审查者，说明您需要的反馈类型。例如，您是需要快速浏览还是更深入的批评？此外，您可以使用 GitHub Copilot 生成拉取请求的摘要。请参阅本文后面的使用 GitHub Copilot 生成拉取请求摘要。

如果您的拉取请求涉及多个文件的更改，请为审查者提供审查文件的顺序指南。建议从何处开始以及如何进行后续审查。

在提交之前，先审查、构建并测试您自己的拉取请求。这可以让您在其他人开始审查之前捕获可能遗漏的错误或拼写错误。

有多种工具可以帮助您在其他人审查之前，对拉取请求进行潜在安全问题的检查。进行安全审查有助于提前发现并解决安全问题，并让您将未解决的风险标记出来，供他人审查和提供建议。例如，您可以

检查依赖差异，看看您的拉取请求是否引入了有漏洞的依赖项。参见在拉取请求中审查依赖变化。
查询 GitHub Advisory Database，以获取有关漏洞依赖的更多上下文和信息。
调查并解决任何失败的安全检查或工作流，例如依赖审查操作或代码扫描结果检查。参见关于依赖审查和在拉取请求中分流代码扫描警报。
如果您的仓库已将代码扫描设置为拉取请求检查，请使用 GitHub Copilot Autofix 为代码中的安全漏洞提供修复建议。参见在拉取请求中分流代码扫描警报。

拉取请求的作用不仅仅是记录代码更改——它们也是让团队和管理者了解工作状态的强大方式。通过在拉取请求中展示进度，您可以减少单独更新的需求，确保所有人保持一致。

注意

你需要拥有 GitHub Copilot 的访问权限。有关详细信息，请参阅 GitHub Copilot 是什么？。

您可以使用 Copilot 在 GitHub 上生成拉取请求的摘要。该摘要可帮助审查者了解您的更改。

在 GitHub 上，创建拉取请求或导航到已有的拉取请求。

注意

Copilot 不会考虑拉取请求描述中已存在的内容，因此最好从空白描述开始。
定位到您想要添加拉取请求摘要的文本框。
- 如果您正在创建新拉取请求，请使用 “Add a description” 字段。
- 如果您在为已有的拉取请求添加描述，请编辑开篇评论。
- 如果您将摘要作为评论添加，请跳转到拉取请求页面底部的 “Add a comment” 区域。
在文本字段的标题栏中，选择，然后点击摘要。
等待 Copilot 生成摘要后，仔细检查结果。
添加任何可帮助查看拉取请求的人的额外上下文。
当您对描述满意后，在新拉取请求上点击 Create pull request，或在编辑已有描述时点击 Update comment。