| 标题 | 标签 |
|---|---|
| 5 tips for better Pull Requests(更好拉取请求的 5 个小技巧) | github,programming(存储库,应用) |
编写好的代码只是工作的一部分。 以下是改进拉取请求并帮助人们审查它们的 5 个技巧：
那些能够得到更彻底、更自信的审查并且最常被开发人员在有限的时间内优先考虑的拉取请求是最小的请求。确保将关注点分成不同的拉取请求（例如重构和功能实现），同时保持提交原子性和详细记录，以使更改更易于理解和审查。
始终花时间描述你的代码以及拉取请求中的任何相关任务。 解释你正在实现的功能或你正在修复的错误，并提供图像和重现步骤（如果适用）。 记下实施过程中做出的决策、你的方法以及可能帮助其他人更好地理解你的代码的任何限制、发现和兴趣点。
始终将你的拉取请求重新设置到存储库的主分支上。 这样，你始终可以根据最新更改测试代码并解决合并冲突，从而最大限度地减少以后可能出现的问题。 除此之外，审阅者不必处理可能已经部署的缺失功能或错误修复，这可以大大加快审阅时间。
在提交拉取请求以供审核之前，请务必花时间亲自进行审核。 这样你就可以处理一些容易实现的成果（打字错误、简单的优化、剩余代码等），并检查你在其他人的拉取请求中要做的事情。 自我审查还有一个额外的好处，可以让你对决策进行推理并意识到哪些决策可能需要澄清。
提交拉取请求后留出一些时间来回复评论。 尽快处理任何事情，并在必要时开始讨论以达成解决方案。 对审阅评论中建议的更改使用 --fixup 或添加新的提交以帮助审阅者更轻松地解析新更改。 最后，表现出良好的意愿、礼貌并感谢你的同事。