5个提高Pull Requests质量的技巧
编写优秀的代码只是工作的一部分。以下是5个提高您的Pull Requests并帮助他人进行审查的技巧:
小型Pull Requests
那些被开发人员更仔细、更自信地审查并且最常被优先考虑的Pull Requests是最小的那些。确保将不同的关注点分开到不同的Pull Requests中(例如重构和功能实现),同时保持提交的原子性和良好的文档化,以便更容易理解和审查所做的更改。
良好的描述
在您的Pull Request中,始终花时间描述您的代码和任何相关任务。解释您正在实现的功能或您正在修复的错误,并提供相关的图片和重现步骤(如果适用)。记录实现过程中的决策、方法,以及任何限制、发现和有助于他人更好理解您的代码的重要点。
在主分支上进行变基
始终将您的Pull Requests变基到存储库的master
分支上。这样,您可以始终针对最新的更改测试您的代码并解决合并冲突,从而最小化可能在后续出现的问题。此外,审查者将不必处理可能已经部署的缺失功能或错误修复,这可以大大加快审查时间。
自行审查
在提交Pull Request进行审查之前,始终花时间自行审查。这样,您可以处理一些低难度的问题(拼写错误、简单的优化、残留代码等),并检查您在他人的Pull Requests中会检查的事项。自行审查的额外好处是可以让您思考决策并意识到哪些决策可能需要进一步澄清。
回复评论
在提交拉取请求后,留出一些时间来回复评论。尽快处理所有可以处理的事情,并在必要时开始讨论以达成解决方案。对于评论中提出的更改建议,可以使用--fixup
进行更正,或者添加新的提交以帮助评论者更容易地解析新的更改。最后,假设评论者的意图是好的,保持礼貌并感谢你的同行。