code-review

--- name: code-review description: 代码审查 Skill - 自动化代码质量检查与报告生成工具。支持从 GitHub 等仓库克隆代码、执行多维度代码质量检查、生成结构化审查报告并按场景保存与分发。当用户提到"代码审查"、"code review"、"检查代码质量"、"审查报告"等审查操作时，或当用户明确提到对 code-review（本技能）执行"安装 / 更新 / 升级"操作时，或当用户主动提及使用本 skill / 调用本技能时，请使用本 skill。 version: 1.4.0 author: tinycen --- # 代码审查 Skill 使用指南 本 Skill 提供自动化代码审查能力。本文档为入口导航页，具体执行规范拆分到 `workflows/` 与 `references/` 下的对应文件中。 > 路径规则与仓库获取规范详见 [references/repository_access.md](references/repository_access.md)。 --- ## 🔧 工作流 `workflows/` 目录包含本 Skill 的核心执行流程，按触发场景分为以下工作流： | 工作流 | 说明 | 文档 | |--------|------|------| | 工作流一：手动触发 | 用户主动要求审查单个仓库时使用，无条件执行完整审查流程。 | [workflows/manual_workflow.md](workflows/manual_workflow.md) | | 工作流二：定时触发 | 定时任务或自动化调度触发单个仓库审查时使用，先检查版本是否变化，仅在有变化时执行审查。 | [workflows/scheduled_workflow.md](workflows/scheduled_workflow.md) | | 工作流三：前后端跨仓库联调审查 | 用户显式指明前后端仓库对照关系时使用，分别审查前后端单仓质量，并检查联调一致性。支持手动与定时两种触发模式。 | [workflows/cross_repo_integration_workflow.md](workflows/cross_repo_integration_workflow.md) | 工作流执行时可按需启用并行加速策略： - 环境支持子代理时，跨仓库联调审查、多仓库批量审查等场景可按 [workflows/strategies/subagent_strategy.md](workflows/strategies/subagent_strategy.md) 拆分任务并行执行，以缩短整体耗时。 - 子代理策略为可选策略，环境不支持时自动降级为串行执行，不影响审查流程完整性。 执行前必须先确定当前场景并选择对应工作流，禁止混用。跨仓库联调审查必须确认用户已显式指明前后端对照关系，不得仅凭两个仓库地址自动推断。 > 💡 **技能安装 / 更新 / 升级**：若用户要求的是安装、更新或升级本技能本身（而非执行代码审查），请直接阅读 [references/installation.md](references/installation.md)，根据当前环境选择对应的安装或更新方式（Prompt 安装、OpenClaw CLI、IDE / 其他 CLI、ModelScope 备选）执行，**无需**进入上述审查工作流。 --- ## 🎯 场景路由表 | 场景 | 文档 | |------|------| | 手动触发代码审查（用户主动要求 / 本地审查 / 远程对话） | [workflows/manual_workflow.md](workflows/manual_workflow.md) | | 定时触发代码审查（自动化调度 / 定时任务） | [workflows/scheduled_workflow.md](workflows/scheduled_workflow.md) | | 前后端跨仓库联调审查（用户显式指明前后端对照关系） | [workflows/cross_repo_integration_workflow.md](workflows/cross_repo_integration_workflow.md) | | 仓库获取、SSH 配置、版本信息获取 | [references/repository_access.md](references/repository_access.md) | | 审查规则、检查维度、问题分级 | [references/review_process.md](references/review_process.md) | | Python 异常处理检查（异常链 `raise ... from`） | [references/language_checks/python_exception_handling.md](references/language_checks/python_exception_handling.md) | | Python URL 构造检查（`urlencode` 参数化构造） | [references/language_checks/python_url_construction.md](references/language_checks/python_url_construction.md) | | 报告格式、保存、分发与通知 | [references/report_delivery.md](references/report_delivery.md) | | 单仓审查报告模板 | [references/templates/report.md](references/templates/report.md) | | 跨仓库联调审查报告模板 | [references/templates/cross_repo_report.md](references/templates/cross_repo_report.md) | | 已忽略与误报问题清单模板 | [references/templates/ignored_issues_template.md](references/templates/ignored_issues_template.md) | | 安装与更新 | [references/installation.md](references/installation.md) | --- ## 📁 文件目录结构 ``` code-review/ ├── SKILL.md # 入口文件（本文件），场景路由 ├── workflows/ # 工作流编排 │ ├── manual_workflow.md # 工作流一：手动触发 │ ├── scheduled_workflow.md # 工作流二：定时触发 │ ├── cross_repo_integration_workflow.md # 工作流三：前后端跨仓库联调审查 │ └── strategies/ # 工作流执行策略 │ └── subagent_strategy.md # 子代理并行审查策略 └── references/ # 参考文档 ├── review_process.md # 代码审查流程与规则 ├── cross_repo_integration_checks.md # 跨仓库联调一致性检查维度 ├── report_delivery.md # 报告保存、分发与通知 ├── templates/ # 报告与清单模板 │ ├── report.md # 单仓审查报告模板 │ ├── cross_repo_report.md # 跨仓库联调审查报告模板 │ └── ignored_issues_template.md # 已忽略与误报问题清单模板 ├── repository_access.md # 仓库获取规范 ├── installation.md # 安装与更新 ├── python_dependency_installation/ # Python 依赖安装 │ ├── review_tools.md # 审查工具依赖安装 │ └── project_dependencies.md # 项目业务依赖安装 ├── frontend_dependency_installation/ # 前端依赖安装 │ ├── node_environment.md # Node 环境管理（Volta） │ └── project_dependencies.md # 前端项目业务依赖安装 └── language_checks/ # 语言专项检查 ├── python_type_check.md # Python 类型检查 ├── python_pypi_packaging.md # Python PyPI 包依赖与打包 ├── python_exception_handling.md # Python 异常处理（异常链保留等） ├── python_url_construction.md # Python URL 构造（urlencode 参数化等） └── typescript_javascript_check.md # TypeScript/JavaScript 检查 ``` --- ## 📂 报告输出目录结构 审查报告默认输出到被审查项目的 `docs/code_reviews/` 目录。 **单仓审查**（工作流一、工作流二）： ``` docs/code_reviews/ ├── <日期>-<模型>-代码审查报告.md # 新生成的审查报告（待用户处理） ├── fixed/ # 待工具扫描的收件箱（用户手动放入已审阅报告） │ └── <日期>-<模型>-代码审查报告.md ├── archived/ # 已被工具扫描归档的报告（不再重复扫描） │ ├── <日期>-<模型>-代码审查报告.md │ └── ... └── ignored_issues.md # 已忽略与误报问题清单（自动维护，跨次审查持久化） ``` **跨仓库联调审查**（工作流三）： - 前端单仓报告：`前端仓库/docs/code_reviews/<日期>-<模型>-前端代码审查报告.md` - 后端单仓报告：`后端仓库/docs/code_reviews/<日期>-<模型>-后端代码审查报告.md` - 联调报告：`主仓库/docs/code_reviews/<日期>-<模型>-前后端联调审查报告.md` - 忽略与误报清单：`主仓库/docs/code_reviews/ignored_issues.md` > `fixed/` 与 `archived/` 目录说明： > - **`fixed/`（收件箱）**：用户查看报告后，将已确认处理（标记了忽略、误报或修复了问题）的报告移至 `fixed/` 目录。 > - **`archived/`（归档）**：工具在审查前扫描 `fixed/` 目录中的报告提取忽略与误报标记后，**自动把 `fixed/` 下全部报告移动到 `archived/` 目录**，使 `fixed/` 保持为空。下次审查只扫描用户新放入 `fixed/` 的报告，避免重复扫描。 > - **报告扫描范围**：仅扫描 `fixed/`，不扫描 `archived/`（已归档），也不扫描根目录下的新生成报告。 > - **原报告引用**：`ignored_issues.md` 中「原报告」字段只记录文件名，对应文件已归档于 `docs/code_reviews/archived/` 子目录。 --- ## ❓ 常见问题 详见 [FAQ.md](FAQ.md)。 --- ## 📦 安装与更新 ### 技能安装 Skill 的安装说明与更新步骤，详见 [references/installation.md](references/installation.md)。 ### 审查环境准备 执行审查前需准备所需的审查工具与项目业务依赖： - Python 审查工具依赖（Pyright、Pyrefly、pyupgrade、Ruff 等）的环境检测、安装与升级，详见 [references/python_dependency_installation/review_tools.md](references/python_dependency_installation/review_tools.md)。 - 被审查 Python 项目业务依赖的安装策略，详见 [references/python_dependency_installation/project_dependencies.md](references/python_dependency_installation/project_dependencies.md)。 - 被审查前端项目的 Node 环境准备（Volta）与业务依赖安装策略，分别详见 [references/frontend_dependency_installation/node_environment.md](references/frontend_dependency_installation/node_environment.md) 和 [references/frontend_dependency_installation/project_dependencies.md](references/frontend_dependency_installation/project_dependencies.md)。

存档时间线

版本索引永久保留；内容副本只保留最新 1 份，更早版本仅留索引与哈希（存档时间线的证据链不会因此断裂）。

下载存档内容副本

相关资产