提供拉取请求的审查¶
欢迎大家对 BeeWare 项目做出任何贡献。在开始之前,我们需要注意一些重要事项。
审查前请思考¶
在进行评论之前,请深思熟虑。作为审稿人,我们应该考虑一下我们即将发出的回复是否:
- 确实如此。始终努力提供准确的建议和信息。
- 有帮助。我们正在就如何改进提交材料提供指导;该指导应明确指出问题的根源或未考虑的用例,最好能提供解决或消除顾虑的途径。
- 激励。我们要做的就是激发作者的灵感,让他们愿意按照我们的要求进行修改。
- 必要。我们期望作者会阅读我们发布的所有内容;我们必须尊重他们的时间和精力,只在必要时发布。
- 善意。同样的反馈有多种表达方式;我们需要确保自己的言辞是善意的、支持性的和建设性的。
既要思考,又要提供有效的评论是完全可能的。以上讨论的概念并不排除指出您在 PR 中发现的任何问题。如果投稿人没有意识到需要改进的地方,他们就没有机会改进自己的投稿。重要的是要注意**你是如何提出这些反馈意见的。尽量使你的审查非个人化。与其说 "你犯了一个错误",不如说 "这段代码可以改进"。审查代码,而不是作者。
除了找出需要改进的地方,提供积极的反馈也很重要。例如,如果改动特别有用、做得特别巧妙,或者向你介绍了一个你不知道的应用程序接口,请告诉作者!千万不要低估在你指出的其他问题都需要解决的情况下,指出别人做得正确或好的地方的效果。
GitHub 审核建议¶
GitHub 的审核界面有一个变更建议机制,您可以在其中提供您所建议的确切变更,作为现有内容的替代。请记住,在这些建议被接受并提交之前,它们不会通过预提交和过滤检查。因此,该功能应该用于较小的更改,因为建议的更改越大,引入问题的可能性就越大。