SuperAPI AI 工具集

artifact-review

前端与建站

查看项目

更新于 10-16 02:36

技能介绍

用途:artifact-review 是评审侧的代码评审产物技能,目标是在一个页面上呈现评审者关注的全部 diff 片段与按顺序排列的评审意见,让打不开 PR 的开发者也能获得足够上下文采取行动。适用于用户粘贴 PR 链接或补丁请求评审、需要把评审反馈发到邮件或 Slack、或评审者已留评论后想输出结论与主要问题的场景。若需要作者侧的 PR 描述,改用 artifact-report 的模板。

主要能力:输出契约固定为一个 .html 文件,扩展名始终为 .html;diff 片段用 <div class="diff"> 与 <div class="diff-row"> 渲染,不使用 diff 代码围栏;评审意见用 <aside class="note review-comment"> 渲染,不使用 Markdown 引用块。使用 templates/ 中的模板,并将 artifact.css 内联进 <style>(单文件可移植模式)或用 <link> 引用。采用库的 .diff 系统并增加内联评论线程,页面为静态,无需 jQuery。

使用方式:先阅读 artifact-css/SKILL.md 了解完整输出契约、设计系统与页面骨架。页面由六块按序构成:页头(含仓库路径与 PR 编号 eyebrow、PR 标题 h1、评审者自己一句话概括的 lead)、结论块(callout 加结论徽章,Approve 用 .badge-success、Request changes 用 .badge-danger、Comment 用 .badge-info)、摘要记分卡(.kv-strip 五格:改动范围、风险、测试覆盖态度、向后兼容影响、发布安全性)、主要问题(三条到五条,以 Fix/Reconsider/Ask/Confirm 等动词开头并链接到 #h-N)、带批注的 diff(.review-hunk 内含 .file-label、.hunk-anchor、.diff 及 .review-comment 卡片)、未评审内容清单,页尾附评审者与时间戳及复审承诺。批注卡包含头像、行号引用(如 L42-45)、严重级标签、评论文本和可选建议替换代码。严重级与样式配对:must-fix 用 .note-danger/.badge-danger,should-fix 用 .note-warn/.badge-warn,nit 用 .note-info/.badge-info,praise 用 .note-success/.badge-success。

限制与约定:输出文件格式固定,不接受 markdown。严重级应如实标注、避免通胀;意见应具体而非笼统,修复建议尽量以代码给出;结论不得与评论矛盾;diff 需经筛选而非整段粘贴,跳过的上下文用 .diff-row.hunk 省略;无行级锚点的问题应放入“未评审内容”块。生成后应提供两个衍生版本:可粘贴到 Slack 的纯文本版,以及格式化为 GitHub PR 评审的逐文件逐行内联评论列表。官方未提供的内容暂未说明。