帮助他人评审你的更改

创建拉取请求时，会要求团队评审你的更改并提供反馈。本指南提供了创建易于评审的拉取请求，以便让你的团队保持知情，从而改进协作和评审质量的最佳做法。

使更改易于评审

在拉取请求中提供清晰的上下文，有助于评审者快速了解你更改的内容及其重要性。这使得评审过程更加快速和顺畅，减少了来回沟通，并能帮助团队提供更好的反馈，从而做出更有信心的决策。有关拉取请求创建的详细信息，请参阅“创建拉取请求”。

创建能够实现单个目的、重点明确的小型拉取请求。拉取请求越小，进行审查和合并的难度越低，速度越快，引入 bug 的可能性越低，并且可提供更清晰的更改历史记录。

首先审查、生成和测试自己的拉取请求，然后再提交。这有利于在其他人开始审查之前发现可能漏掉的错误或错别字。

为拉取请求编写清晰的标题和说明，以便审阅者可以快速了解拉取请求的作用。在拉取请求正文中包含以下内容：

为方便审阅者，请说明所需的反馈类型。例如，你是需要快速查看还是更深入的点评？此外，还可使用 GitHub Copilot 来生成拉取请求的摘要。请参阅本文后面的“使用 GitHub Copilot 生成拉取请求摘要”。

如果拉取请求包含对多个文件的更改，请向审阅者提供有关文件审查顺序的指导。建议从何处开始以及如何进行审查。

拉取请求不仅仅是记录代码更改，它们还是一个强大的工具，可以让你的团队和经理了解你工作的状态。通过在拉取请求中展示你的工作进度，你可以减少单独更新的需求，并确保每个人都保持一致。

Note

需要 GitHub Copilot 订阅。有关详细信息，请参阅“什么是 GitHub Copilot？”。

可以使用 Copilot 在 GitHub 上生成拉取请求摘要。可以使用摘要来帮助评审者了解你所做的更改。

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

Note

GitHub Copilot 不会考虑拉取请求说明中的任何现有内容，因此最好从空白说明开始。
导航到要在其中添加拉取请求摘要的文本字段。
- 如果要创建新的拉取请求，请使用“添加说明”字段。
- 如果要向现有拉取请求添加说明，请编辑打开的注释。
- 如果要添加摘要作为注释，请导航到拉取请求页面底部的“添加注释”部分。
在文本字段的标题中，选择，然后单击“摘要”****。
等待 GitHub Copilot 生成摘要，然后仔细检查结果。
添加任何其他上下文，为查看拉取请求的人员提供帮助。
对说明感到满意时，请在新拉取请求上单击“创建拉取请求”，或在编辑现有说明时“更新注释”。

将拉取请求连接到相关议题或项目版块，以展示你的工作如何融入更大的项目中。

为你的拉取请求添加状态标签，以显示它是已准备好评审、被阻止还是正在进行中。这有助于评审者一目了然地了解你的工作状态。有关详细信息，请参阅“管理标签”。