SuperAPI AI 工具集

pr-quiz

编程与开发

查看项目

更新于 11-16 14:44

技能介绍

PR quiz 是一个面向代码评审场景的出题技能,用于在 PR(GitLab 上为合并请求)评审过程中,向作者提出关于其自身改动的少量选择题,以检验作者是否理解了这次变更。根据资料,测验不会阻塞合并,因此只有在评审者希望作者认真思考过改动时才值得出题。

主要能力与出题维度: 每道题只考察一个维度:

  • 设计意图(design-intent):为什么这样改而不是用别的方式;
  • 影响范围(impact-surface):影响哪些调用方、流程或已存储的数据;
  • 边界(boundary):空值、并发、顺序、重复调用、旧数据等情形;
  • 失败模式(failure-mode):某一步失败、超时或重试时会发生什么,以及如何降级或回滚。 至少一半的题目应为设计意图或失败模式。正确答案必须能从代码和 diff 推出,不能询问代码无法体现的意图。

选项与题目规则: 每题给出 3 到 5 个选项,恰好一个正确;错误选项应是一个匆忙的作者可能犯的错,例如漏掉错误分支、忘记另一个调用方、混淆两个相似概念,不能出现荒谬选项。选项在长度和细节上应相近,正确选项不能是最长的。禁止出记忆题,例如问哪个文件、函数或变量变了,或任何可以直接从 diff 复制的内容。

语言与措辞要求: 题目面向在 PR 评论之间阅读的作者,要求像同事在工位旁提问那样平实。中英文各有具体限制:英文题干为一到两句短句、约 25 词以内,选项约 12 词以内;中文题干约 60 字以内,选项约 25 字以内。选项只陈述用户或调用方看到的结果,原因写进解释,不得在选项中出现“因为”“由于”“所以”“从而”“导致”等因果表达。整道题最多使用一个用反引号标注的代码名,且只在没有通俗名称时才用;不要串联名称或生造术语,应使用用户和调用方熟悉的说法,如会话、设置页、调用方、重试。还需避免“在……时”“当……时、此时……怎样”这类句式、过长定语、三个及以上顿号并列、“不是……而是……”以及生造术语。

流水线校验: 资料说明流水线会丢弃超过长度限制、代码名过多、使用特定禁用表达或选项中含有原因的问题,也会丢弃询问文件、函数、方法、变量、类或行号以及“某东西叫什么”的问题。

字段结构: 每道题包含 dimension(上述四个维度之一)、prompt(题干)、options(不带字母的选项文本,由流水线添加字母并打乱顺序)、answer_index(正确选项在 options 中的从零开始的索引)、explanation(两三句平实的话,说明正确选项为何对、主要错误选项为何错,回答后展示;引用选项时按内容而非字母或位置)、evidence(最多三个支持答案的改动位置,每个为路径和改动后一侧的行号)。

使用方式与适用场景: 资料说明该技能仅在 MCode Review 流水线要求作者测验时使用,用于 PR 评审环节出题。具体安装与调用命令暂未提供。

限制: 测验不阻塞合并;题目不得涉及代码无法体现的意图,不得出记忆题;选项不得包含原因;需遵守中英文长度与措辞约束。除上述内容外,资料未提供价格、平台支持范围或效果数据。