在Upsource中有序的代码评审
代码审查不像其他开发实践那样依赖于人类的高效。对于我们大多数人来说,要做到这一点,很重要的一点是要把我们的任务安排得井井有条,时间安排得井井有条。
Upsource为你处理了很多事情,不需要配置任何东西。例如,如果你有一个分支审查,它会自动添加新的修订。它会迅速通知你需要注意的事情。它会跟踪哪些更改您已经看到,哪些更改您还没有看到,因此您只需要回顾那些您还没有看到的更改。
通过一些必要的配置,您可以自动完成更多的工作。您可以设置一个自定义工作流,该工作流可以创建评审、从特定的用户池分配评审人员、关闭评审和/或在每个人接受更改时解决讨论。
如果这还不够,Upsource提供了一些工具来增加额外的有序。让我们来看看其中的一些。
总的来说,评审人员最好尽快完成他们的部分,这样代码评审就不会堆积起来,阻碍过程,变得更不相关,更难以合并。但是,可能会出现某一评审员或一组评审员积累了大量的代码评审要进行的情况。在这种情况下,了解这些代码审查的优先级对他们是有帮助的。一种方法是,当你知道代码审查的截止日期时,要养成手动设置截止日期的习惯。
或者,作为一个团队,您可以使用代码审查级别标签来表示优先级。您可以使用一个标签将某些代码评审标记为“紧急”,或者创建一个更细粒度的优先级标签系统。
当然,标签也可以用于其他事情。例如,如果您为一个分支或一个pull请求创建了一个代码审查,并且希望尽早与您的同事就一些设计决策进行磋商,当讨论这些事情还为时不晚时,您可以将该审查标记为“需要帮助”。另一方面,如果您还没有准备好向评审人员显示您的更改,您可以将“工作进行中”放在那里,并在需要时切换到“准备评审”。
如果愿意,您可以使用代码审查标签来标识代码审查中的更改类型(bug、功能等),不过,有人可能会认为,在提交消息中或通过问题跟踪票证链接这些信息更合适。相反,代码评审中的标签讨论可能会有所帮助。Upsource有预定义的讨论标签,如“bug”、“增强”等,但您当然可以添加更多。例如,“技术债务”。
在代码评审中开始讨论时,您还可以以可操作的方式组织自己的反馈。如果您有很多关于如何改进正在审查的代码的建议,请使用markdown在您的评论中生成一个检查表。用- [ ]
,和完成的- [x]
.这将在注释中呈现一个复选框列表。当您或代码作者检查检查表时,您只需选中或清除复选框,即可自动更新检查表。
最后但同样重要的是,检查你的通知设置-点击右上角的个人资料图片,然后去“通知”。虽然最重要的通知是默认打开的,但也有一些是可选的,但您可能会觉得有用。比如,一个提醒,你已经忘记完成一个审查,或关于活动与GitHub同步的通知。
您还可以自定义通知,以接收有关非常特定的内容(如某些文件正在更改)的更新。
虽然没有关于如何更好地组织代码审查的“一刀切”指南,但我希望您在本文中找到一些对您的团队有用的想法。
代码评审快乐!
马丁·莫特森说:
2018年11月19日是否可以通过提交注释添加标签?例如,写[bug]或类似的东西?
玛丽亚Khalusova说:
2018年11月22日嗨,马丁!对不起,这是不可能的,但这是一个有趣的想法!谢谢!