如何最佳评论提取请求(没有治理解决方案) 在技术领域,我们始终致力于写出更好的、更强大的、更可维护的代码。代码审查是这个过程的重要组成部分.然而,这是一个我们很少专注于改进的技能。 成为一个质量评论员可以让你成为你的团队的真正资产,但这并不容易。 在该 可以改变你的团队的动态,并为你开辟成功之路。 正确的事情 正确的方式 The Purpose of a PR Review 一个PR评论的目的 作为工程师,我们的主要工作是编写代码,解决问题,让世界一转一转,但我们在审查代码时扮演什么角色?这个问题可能会令人不安,尤其是在第一次被要求审查别人的代码时。 So, let’s start with what you’re not expected to do: 你不希望为作者解决问题。 你不需要重写他们的代码来匹配你的愿景。 So, what are you responsible for? 一个团队的成功往往取决于制作代码的质量,以及关键问题被发现和解决的速度。 提出的问题已经解决, 该解决方案是清洁和可测试的,并 代码是有效和完整的。 通常情况下,解决方案将看起来与你如何解决它非常不同,这很好......这与评论无关,重要的是代码是否有效,是否可维护,并且可以有效地测试。 评论的另一个主要好处是知识转移. 每个人都会以不同的方式解决问题,评论代码是团队互相学习的机会。 所以,让我们再深入一点,谈谈你为什么要这样做。 Is This Done? 这个做到了吗? 我们都已经在那里:你开始解决一个问题,发现一个酷的指数想法,突然你正在构建一些完全不同的东西. 你到达终点,你兴奋地抓住你的想法,让所有人看到,只是为了意识到你没有真正解决你打算解决的问题。 PR评论可以帮助我们避免这些小错误,使它进入生产,并引起客户的烦恼。评论员应该专注于当前的问题。对与这个PR相关的门票有一点熟悉,阅读了README或PR评论,并对正在解决的问题有一个坚实的理解。 Housekeeping 家政 我们大多数人会以重复的方式写代码,这意味着我们本能地解决问题,然后重写代码几次,使其尽可能清洁,清晰和高效,但有时,我们不会像我们可能要到达真正的底线那样进行很多重复。 一个审查应该集中在这个代码是否处于一个状态,它将很容易测试和维护;这就是它。阅读代码,并预测未来可能出现的错误或更改,以及这个代码是否难以调试或更改?如果它看起来令人困惑或复杂,我们可能应该简化它。 你不是在这里为作者解决问题,而是为了确保他们自己解决了问题. 技巧和技巧帮助我们学习和成长,所以你的建议是欢迎的,但不要让它成为一个阻碍的问题。 Conclusion 结论 代码评论不是要证明你是房间里最聪明的工程师,或者强迫每一个解决方案都匹配你的风格,而是要保护质量,确保可测试性,并通过共享知识来加强团队。 如果你通过专注于 代码实现了,而不是 当你到达那里时,你会帮助你的团队更快地移动,建立信任,并促进合作。 什么 如何 在下一部分,我们将深入到 原则和做法,使评论有效,尊重和生产力. 因为即使你知道目的,它需要真正的技能来提供反馈,这提高了代码和编码器。 如何 原创发布: https://substack.com/@halexmorph