向 GitHub diff 添加重构注释
代码审查是现代软件开发的关键实践。目前,这种做法是使用文本差异工具来执行的,例如 GitHub 提供的工具。然而,差异结果很容易变得复杂且难以理解。例如,重构在 diff 结果中根本不表示。这增加了对差异的理解,因为审阅者需要自己推断一组给定的添加和删除的代码行代表,例如提取方法。
RAID 是一个工具管道,可以通过重构信息无缝地丰富 GitHub diff 结果。该管道具有三个关键组件:
- RefDiff:检测提交中重构操作的工具。在我们的架构中,我们依靠 GitHub 操作在每个 Pull 请求后自动执行 RefDiff。
- 外部服务器,收集 RefDiff 生成的重构列表。
- 一个 Chrome 插件,可以无缝注释与重构相关的差异块。正如我们所描述的,目标是轻松地向开发人员传达添加/删除代码行背后的原因。
源代码:https://github.com/rodrigo-brito/refactoring-aware-diff
安装
- 安装 Refactoring-Aware Review Chrome 扩展
- 在 GitHub CI 中包含重构感知差异操作(可在 Github 描述中找到)
- 提交新的 Pull Request 来测试扩展
可以在此处查看带有提取的重构的 Pull 请求示例:https://github.com/rodrigo-brito/refactoring-aware-diff/pull/5/commits
错误报告:https://github.com/rodrigo-brito/refactoring-aware-diff/issues
RAID: Refactoring-aware and Intelligent Diffs插件谷歌浏览器安装教程
第一步:下载RAID: Refactoring-aware and Intelligent Diffs安装扩展
第二步:下载下来的扩展解压到你想放的文件夹里
比如我解压到extend文件夹
打开Chrome的扩展页面(chrome:// extensions /或按Chrome菜单图标>更多工具>扩展程序),右上角开发者模式,点击开启,蓝色为开启,灰色为关闭;
再次将crx文件拖放到扩展程序,页面左下角提示:“扩展功能、应用和主题背景可能会损害您的计算机。您确定要继续吗?”
点击“继续”依然显示“无法从该网站添加应用、扩展程序和用户脚本”。尝试另一种办法方法。
第三步:把crx后缀改为zip,再进行解压
如果有些windows电脑系统查看不到文件扩展名,则可以通过以下设置:
找到文件夹顶部,点击查看
点击查看,找到隐藏已知文件扩展名,去掉前面的勾即可
这样你就能看到解压好的扩展名:.crx
解压的扩展名为.crx
把.crx改为:zip
然后再用解压工具再解压一遍,即可得到扩展的全部文件
然后再谷歌浏览器插件页面选择:加载已解压的扩展程序
这样就安装成功了
友情提醒:
其他浏览器,包括qq浏览器,360浏览器,edge浏览器,猎豹浏览器,搜狗浏览器安装插件的方法都是类似的,以上内容大部分通用!






