如果管理人员只能绘制一个流程图来解释代码审查的工作方式,那么对他们来说将更加容易。 然后,经理将通过电子邮件向所有同事发送电子邮件,告知每个人都应遵循新流程。
有许多方法可以在组织中实施代码审查 。 当然,这不是其中之一。
代码审查是一种根据外部元素而变化的实践。 所以我提出一个问题:这是一种实践还是一种文化?
根据《剑桥词典》,一种做法是
“通常或习惯做的事,通常作为习惯,传统或习俗来做”
同一本词典将文化一词定义为
“在特定时间特定人群的生活方式,特别是一般习俗和信仰”。
话虽如此,看来Code Review确实是一种实践。 这是每天执行的事情,迟早会成为开发人员的习惯。 这种习惯是开发人员和工程师所固有的,他们觉得软件开发和代码审查之间没有区别。
下面,我将介绍一些影响实践的健康性和有效性的文化方面。
包含代码的评论
为确保审核内容全面,首先要做的是告诉团队成员他们应明确审核代码。 当实施一种新做法时,并不是每个人都完全了解他们的例行工作发生了什么变化。
强制执行的关键点是,“拉取请求”是学习和共享知识的理想场所。 在这里,您可以提出问题,考虑替代解决方案并仔细研究新想法。 成为初级或有经验的开发人员; 总有一个相关问题的空间。
审核需要时间
开发人员需要多少次来审查拉取请求? 我认为这个问题没有答案。 有许多因素需要考虑。
它们包括拉取请求的大小,代码复杂性,对代码库的熟悉程度,审阅者的全面程度,仅举几例。 但是,它们与文化无关。 它们与拉取请求本身有关。
例如,当经理们通过提交,代码行或合并的数量来衡量生产力时 ,他们正在对实践施加压力。 在这种情况下,开发人员倾向于花更多时间编写代码,而不是花时间审查。
通过隐式方式,管理人员告诉开发人员,打开或关闭请求请求比审查请求更为重要。 随着时间的流逝,拉动请求的创建和合并只是一种官僚行为。 不久,团队决定因为不值钱而停止该实践。
从初级到高级,捍卫这种做法必须成为文化的一部分。
通讯
沟通是代码审查的核心。 它增强了协作,在团队成员之间共享知识,并允许开发人员和工程师发展自己的职业生涯。
评论大量使用书面交流。 提升每个人的写作技巧至关重要。 在表达想法,建议和潜在问题时,一切都很重要:语言,语气和表情符号。
如果您不想听起来刺耳,那么一个重要的提示是,更喜欢提问而不是陈述。 “您能指出使用变量的其他地方吗?” 比“删除”要好。
有时问题太复杂而无法在评论中适当地阐述。 在这种情况下,我建议首先寻找指南,博客文章和其他可以提供帮助的资源。
如果太具体了,视频通话应该会有所帮助。 快速的面对面会议很方便。 但是,请不要忘记总结讨论内容并将其发布在pull请求中以用于文档目的。
结论
代码审查受到外部因素的深刻影响。 没有周围的支持文化就不可能存在它。 在这篇博客文章中,我分享了在实施代码审查实践时管理人员应注意的三个文化因素。
From: https://hackernoon.com/code-review-a-practice-that-depends-on-the-culture-tyh3z7o