Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-09-25. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

帮助他人评审你的更改

可以使用拉取请求为更改提供清晰的上下文,并让团队保持知情,从而改进协作和评审质量。

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

使更改易于评审

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

编写小型 PR

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

首先审查自己的拉取请求

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

提供上下文和指导

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

  • 拉取请求的用途
  • 更改内容的概述
  • 任何其他上下文的链接,例如跟踪问题或以前的对话

为方便审阅者,请说明所需的反馈类型。 例如,你是需要快速查看还是更深入的点评?

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

让团队保持知情

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

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

  • 在你的描述中添加关键字(如 Closes ISSUE-LINK),以便在拉取请求合并时自动链接并关闭该议题。
  • 使用 Projects 跟踪你的工作,并从拉取请求中链接到项目,使你可以在一处轻松跟踪进度。 请参阅“关于 Projects”。

使用标签突出显示状态

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