创建拉取请求时,会要求其他人查看更改并提供反馈。 重点明确、清晰且易于理解的拉取请求有助于审阅者提供更好的反馈,并更有把握地提出建议。
使您的更改易于审核
清晰上下文有助于审阅者快速了解更改的内容及其重要原因。 它可以减少来回,加快审查速度,并帮助团队专注于更改最重要的部分。
创建小型拉取请求
小型、聚焦的拉取请求更容易审查,合并起来也更安全。 他们帮助审阅者了解更改的目的,更快地发现问题,并在以后跟踪项目的历史记录。
当改动较大时,考虑将其拆分为多个较小的 Pull Request,使每个请求各自只专注于一个目的。
提供上下文和指导
明确的标题和说明可帮助审阅者了解问题、方法和结果。 良好的上下文通常解释了为什么需要更改、更改的内容以及审阅者应特别注意的位置。
当拉取请求涉及多个文件或需要特定审阅顺序时,指导特别有用。 例如,你可以首先将审阅者指向最重要的文件,或解释哪种类型的反馈最有用。 你还可以使用 GitHub Copilot 生成拉取请求摘要。
首先审查自己的拉取请求
在要求其他人审阅之前查看自己的拉取请求有助于尽早发现错误。 它还会让审阅者知道,该拉取请求已准备好供他们审查。
自我评审可以包括查看差异、检查无意的更改,并确保相关构建或测试已运行。
审查安全性
安全评审有助于在拉取请求合并前发现风险。 当拉取请求更改处理敏感数据的依赖项、身份验证、权限、工作流或代码时,这一点尤其重要。
GitHub 可以在拉取请求中显示安全信息,例如依赖项更改、依赖项评审结果和 code scanning 检查。 使用这些信号提前解决问题,或突出显示需要审阅者注意的风险。
如果存储库已 code scanning 设置为检查, GitHub Copilot自动修复 可以建议修复安全漏洞。
确保团队知悉
拉取请求不仅可以记录代码更改,还能让团队及时了解你的工作进展。 可见进度有助于减少单独的状态更新,并使每个人都保持一致。
链接到相关议题或项目
将拉取请求关联到议题或项目,可以显示这项工作如何融入整个项目。 链接可帮助审阅者了解优先级、跟踪进度并查找相关讨论。
当拉取请求在合并后应关闭某个问题时,请使用问题关闭关键字。 还可以链接到 Projects 以便人们可以在一个位置跟踪工作。
使用标签突出显示状态
状态标签可帮助审阅者了解拉取请求是已准备好接受审阅、受阻,还是仍在进行中。 通过清除标签,用户可以更轻松地确定评审的优先级,并避免在审阅工作准备就绪之前进行评审。