SuperAPI AI 工具集
合作ENAI 行业资讯收藏
Skill 广场Code Review

Code Review

编程与开发

查看项目

更新于 10-15 10:05

技能介绍

用途

Code Review 用于审查 AEM Edge Delivery Services（EDS）项目的代码，遵循既定的编码规范、性能要求和最佳实践。它支持两种使用模式：

  • 模式一：自审（开发收尾阶段）。在写完代码、准备提交或开 PR 之前审查代码，是推荐的工作流集成点。可在内容驱动开发（CDD）工作流的第 5 步与第 6 步之间、运行 git add 和 git commit 之前调用，以便在进入 PR 审查前尽早发现问题。
  • 模式二：PR 审查。用于审查已有的 Pull Request（自己的或他人的），可在合并前审查、通过 GitHub Actions 工作流自动审查，或手动审查特定 PR。

主要能力

自审模式会审查工作目录中所有已修改/新增文件，检查代码质量、模式与最佳实践，对照 EDS 标准进行验证，识别提交前需修复的问题，并捕获视觉截图用于验证。

PR 审查模式会拉取 PR diff 与变更文件，验证 PR 结构（预览 URL、描述），审查代码质量，发布带发现项与截图的审查评论，通过 GitHub 建议或提交提供可操作的修复，并解释每项修复的理由。

审查流程覆盖以下方面：

  • 识别审查模式并收集上下文：自审模式使用 git status、git diff、git diff --staged 查看改动；PR 审查模式使用 gh pr view、gh pr diff、gh api 获取 PR 详情、变更文件与评论。
  • 验证 PR 结构（仅 PR 审查模式）：预览 URL（Before/After）、描述、范围一致性为必需项，关联 issue 为推荐项。预览 URL 格式为 Before: https://main--{repo}--{owner}.aem.page/{path}，After: https://{branch}--{repo}--{owner}.aem.page/{path}。
  • 代码质量审查：JavaScript 方面检查 ESLint（airbnb-base 配置）、无未说明的 eslint-disable、ES6+ 特性、导入含 .js 扩展名、关键渲染路径无框架、第三方库通过 loadScript() 加载、aem.js 不被修改、无未经共识的构建步骤、复用现有 DOM、选择器作用域、无硬编码值、清理 console 语句、错误处理等。CSS 方面检查 Stylelint（standard 配置）、避免 !important、属性顺序、选择器作用域到块、私有类/变量前缀、移动优先、标准断点（600px、900px、1200px，均为 min-width）、不混用 min-width 与 max-width、无未经共识的预处理器或框架。HTML 方面检查语义化标签、标题层级、无障碍属性、head.html 中无内联样式或脚本、营销技术不放在 <head>。
  • 性能审查：Lighthouse 移动端与桌面端分数为绿（理想为 100）、关键路径无第三方库、无布局偏移、图片优化与懒加载、重操作使用 IntersectionObserver 或延迟加载、无阻塞渲染的同步操作、字体高效加载；若提供预览 URL，检查 PageSpeed Insights 分数与 Core Web Vitals（LCP、CLS、INP）。
  • 视觉验证截图：至少捕获主要变更页面/组件的一张截图；响应式变更捕获移动（375px）、平板（768px）、桌面（1200px）；视觉变更捕获 Before 与 After 对比；块变更捕获特定块区域。可用 Playwright 自动化、MCP 浏览器工具或手动捕获，并将截图上传嵌入 PR 评论。
  • 内容与创作审查：内容模型对作者友好、保持向后兼容、无破坏性变更、无提交二进制/静态资源、用户可见字符串来自内容、无应可翻译的硬编码字面量。
  • 安全审查：无敏感数据提交（API 密钥、密码、机密）、无 XSS 漏洞（不安全的 innerHTML、未净化的用户输入）、无 SQL 注入或命令注入、工具页面 CSP 头适当、外部链接带 rel="noopener noreferrer"。
  • 生成审查摘要：自审模式直接报告发现项以继续开发工作流；PR 审查模式按 GitHub 评论结构组织，包含概览、预览 URL 验证、视觉预览、视觉评估、检查清单结果（Must Fix/Should Fix/Consider）与详细发现。
  • 提供可操作修复（仅 PR 审查模式）：首选 GitHub 内联建议（约 70-80% 可修复问题，适合 20 行以内、可表达为行替换的改动，支持一键采纳与正确的 git 归属）；其次为指引评论（约 20-30%，用于主观或架构问题、存在多种方案时）；仅在必要时使用修复提交（多文件复杂重构、需大量测试的改动）。

使用方式

自审模式：自动方式由 CDD 工作流在实现后调用；手动方式使用 /code-review（审查工作目录中未提交的改动）。

PR 审查模式：手动使用 /code-review <PR-number> 或 /code-review <PR-URL>；自动方式通过 GitHub 工作流在 pull_request 事件触发。

适用场景

适用于 AEM Edge Delivery Services 项目的开发收尾自审与 Pull Request 审查，包括新块、缺陷修复、功能、样式、重构等变更类型。

限制

资料未提供该技能的收费、价格、平台支持范围等具体信息。部分审查项（如 Lighthouse 分数、PSI 检查）依赖预览 URL 的可用性；截图上传方式取决于所选方案。