背景
CodeReview
是一种很好的学习方式,也是团队成员之间互动的重要途径。
我在网上找了一些CodeReview
的工具,很多都受限于信息安全方面的限制。
兜兜转转,还是决定采用gitlab
自带的功能, 并辅助一些VsCode插件。虽然有些不太方便,基本上满足了我们前端团队现阶段的需求:对Code
添加评论并能通知相关人
周期
两周完成一次CodeReview
闭环
方式
按项目组分成若干小组。以小组为单位,2个小组之间相互进行代码Review
。假设有A、B两个小组,其中A组发起,B组进行评论。
角色分:A组成员为Develop
, A组组长为Approver
,B组成员为Reviewer
。
过程如下:
操作步骤(以commit
记录为例)
-
选择一个
Commit
记录,鼠标移动到代码上在会提示‘Add commont to this line’
。 -
点击
Comment
小图标添加评论,并@相关人员。重点:@前面要有空格。 -
当其他人添加评论并@你时,在
Todos
会有提醒(可以相互之间实验下)。 -
点击
Todos
行会进入对应的评论列表(进入具体评论页面加载很慢),点击Done
会结束掉此次代码review
。
辅助插件
以上的操作虽然有点麻烦(特别是@对应的人),但可以让一次CodeReview
进行闭环。在此基础上,可以安装VSCode
插件Gitlab Notifications
,在VsCode
中会有提示。
点击Notifications
小图标会跳转到gitlab
的Todos
。
需要添加以下配置:
"gitlab-notifications.url": "http://10.250.112.151:18888/",
"gitlab-notifications.privateToken": "GFjuNTPC8vQfJ8RRzcx2",
privateToken
在gitlab
的user setting-account
里面获取:
10.250.xxx.xxx:88888/profile/acc…
注意事项
因commit
的代码可能比较少,代码的评论可以针对整个工程的文件。CodeReview
开发者(Develop
)在单个文件中@评论人(Reviewer
),Reviewer
对项目中的单个或多个文件进行评论。
依次循环Review
彼此代码