Agent Skills
返回列表
代码审查报告生成器

代码审查报告生成器

开发编程 更新于 2026.08.28

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_fccf428b/md-review

技能介绍

解决什么问题

PR 评审稿通常是一份 Markdown 文档,里面塞满了 unified diff 块和 BLOCKER / MAJOR / NIT 之类的严重度标注。这种纯文本形式对作者本人够用,但对其他人就难用了:没有导航,diff 和评论分离,颜色编码无法体现严重度层级。当评审需要跨团队传阅或长期归档时,一个可以独立打开、布局稳定的 HTML 快照比 Markdown 本身更实用。

管道如何工作

这个技能不依赖任何第三方库,三段 Python 脚本串成一条管道:

  1. diff_parser.py 先读取 .md 文件,把 unified diff 块拆成 hunk 级 JSON;
  2. annotation_extractor.py 提取带严重度标签的注释,并把它们挂到最近的 preceding hunk 上;未匹配到任何 hunk 的注释留到最后单独渲染;
  3. review_html_renderer.py 输出单文件 HTML。--reviewer 是硬性参数,缺失时脚本直接拒绝执行。

渲染结果包含几个固定组件:顶部跳转导航(每条注释带严重度徽章、80 字符预览和锚点链接,标题汇总严重度计数如 3 BLOCKER · 2 MAJOR · 1 NIT)、左侧 unified diff + 右侧注释卡片的双栏布局、可选的 LGTM 批准栏,以及审查者页脚。注释卡片的颜色、图标和 aria-label 遵循 WCAG 1.4.1,避免仅靠颜色传达信息。双栏布局在小视口自动折叠为堆叠。

适用边界

这个技能只处理代码评审稿,不是通用 Markdown 渲染器。如果你要渲染散文、表格或普通 callout,应该用 md-document;如果要按 --- 边界做幻灯片,用 md-slides。它产出的是单作者快照,不是 GitHub PR 评论线程。

两点需要注意:一是严重度约定源自 Google Code Review Developer Guide,如果团队使用不同的分级标准,徽章需要自行对齐;二是涉及发送、发布、部署等外部写入时,技能会先展示目标与影响,等待明确确认——不会静默执行。

使用场景

  • PR 作者把评审稿从 Markdown 转成单文件 HTML,便于全组传阅和归档
  • 评审者想保留带严重度标注的审查快照,在 LGTM 和 findings 间做区分
  • 团队要把评审稿和 diff 并排展示,省去在终端里手动对齐的麻烦
  • 归档系统需要一份独立 HTML 产物,不依赖 Markdown 渲染器

适合人员

  • 后端工程师:需要把 PR 评审稿转成可分享的 HTML 快照
  • 前端开发者:要让 diff 和注释卡片在同一个页面并列展示
  • 技术写手:想按 Google Code Review 规范输出严重度标签
  • 工程团队负责人:需要可长期归档的评审产物,且不暴露外部评论线程