🧪 Skills

easy-code-review

AI代码审核助手,自动审查AI修改的代码,检查是否符合原始需求、是否存在非必要修改

v1.0.0
❤️ 0
⬇️ 104
👁 2
Share

Description


name: easy-code-review description: AI代码审核助手,自动审查AI修改的代码,检查是否符合原始需求、是否存在非必要修改 version: 1.0.0 author: OpenClaw Team permissions:

  • file.read
  • file.write
  • git.read tags:
  • code-review
  • ai-assistant
  • quality-assurance min_openclaw_version: 2026.2

AI代码审核助手 (Code Review Assistant)

触发场景

当用户请求以下任务时,自动激活此技能:

  • 用户说"审核代码"、"检查代码修改"、"review代码"等关键词
  • 用户要求验证AI修改是否符合需求
  • 用户要求检查是否存在非必要文件修改
  • 用户提供了需求描述和修改后的代码,要求对比验证

核心能力

本技能赋予小龙虾以下代码审核能力:

1. 需求符合性检查

执行逻辑:

  1. 解析用户的原始需求描述,提取关键要点:

    • 功能性需求(要实现什么功能)
    • 技术约束(使用的框架、库、版本等)
    • 业务规则(业务逻辑要求)
    • 性能要求(如有)
  2. 对比分析修改内容:

    • 检查每个修改点是否直接服务于需求
    • 标记与需求无关的代码修改
    • 识别过度设计或不必要的复杂性
  3. 输出符合性报告:

    • ✅ 符合需求:列出直接对应需求的修改
    • ⚠️ 部分相关:列出可能相关但非必需的修改
    • ❌ 无关修改:列出与需求无关的修改

检查清单模板:

## 需求符合性检查报告

### 原始需求
{用户描述的需求}

### 关键要点提取
- 功能点1: {描述}
- 功能点2: {描述}
- 技术约束: {描述}

### 修改分析
| 修改文件 | 修改内容 | 符合性 | 说明 |
|---------|---------|-------|------|
| {文件} | {简述} | ✅/⚠️/❌ | {原因} |

### 总体评估
- 符合度评分: X/10
- 建议: {改进建议}

2. 非必要文件修改检查

执行逻辑:

  1. 获取本次修改涉及的文件列表(通过git diff或用户提供)

  2. 对每个文件进行必要性评估:

    • 是否为需求直接涉及的模块
    • 是否为配置文件(检查是否有必要改动)
    • 是否为测试文件(检查是否合理)
    • 是否为文档文件(检查是否相关)
  3. 识别风险修改:

    • 修改了不相关的核心文件
    • 大规模重构但需求很小
    • 修改了依赖版本配置
    • 修改了构建配置文件

警告级别:

  • 🔴 高风险:修改了与需求无关的核心业务文件
  • 🟡 中风险:修改了配置文件或依赖
  • 🟢 低风险:仅修改相关文件

检查报告模板:

## 非必要修改检查报告

### 修改文件统计
- 总修改文件数: X
- 必要修改: X 个文件
- 可疑修改: X 个文件
- 不必要修改: X 个文件

### 详细分析

#### ✅ 必要修改
{文件列表及原因}

#### ⚠️ 可疑修改
{文件列表及风险说明}

#### ❌ 不必要修改
{文件列表及建议处理方式}

### 风险评估
- 风险等级: 🔴/🟡/🟢
- 建议: {具体建议}

3. 代码质量检查

检查项:

  • 代码风格一致性
  • 是否存在硬编码
  • 是否有足够的注释
  • 变量命名规范性
  • 潜在的性能问题
  • 安全漏洞风险

4. 变更影响分析

分析内容:

  • 修改的影响范围
  • 是否会影响现有功能
  • 是否需要数据库迁移
  • 是否需要配置更新

执行流程

用户请求审核
    ↓
解析需求描述
    ↓
获取代码变更信息
    ↓
┌─────────────┬─────────────┬─────────────┐
│ 需求符合性  │ 非必要修改  │ 代码质量    │
│   检查      │    检查     │   检查      │
└─────────────┴─────────────┴─────────────┘
    ↓
生成综合审核报告
    ↓
提供改进建议

使用示例

示例1:基本使用

用户输入:

审核一下这段代码修改是否符合需求。

需求:添加用户登录功能,要求:
1. 支持用户名密码登录
2. 登录成功后返回token
3. 记录登录日志

修改的文件:
- src/auth/login.ts
- src/models/user.ts
- package.json
- tsconfig.json

小龙虾响应: 将按照检查流程,分析每个文件修改的必要性,输出详细的审核报告。

示例2:Git变更审核

用户输入:

帮我review一下最近的git commit,检查是否有不必要的修改

小龙虾响应: 将执行 git diffgit show 获取变更,然后进行审核分析。

异常处理

  1. 无法获取变更信息

    • 提示用户提供变更文件列表或diff内容
    • 指导用户使用git命令获取变更
  2. 需求描述不清晰

    • 引导用户补充需求细节
    • 基于代码变更反推可能的意图并确认
  3. 文件无法访问

    • 提示用户确认文件路径
    • 建议用户提供文件内容

配置选项

用户可通过以下方式自定义审核行为:

# .claw/review-config.yaml
review:
  strictness: normal  # strict | normal | loose
  focus_areas:
    - requirement_alignment
    - unnecessary_changes
    - code_quality
  ignore_patterns:
    - "*.test.ts"
    - "*.spec.js"
  custom_rules:
    - "不允许修改.env文件"
    - "配置文件修改需要确认"

输出格式

审核报告支持多种格式:

  • Markdown(默认):适合在聊天中展示
  • JSON:适合程序处理
  • HTML:适合生成报告页面

技能依赖

  • OpenClaw核心能力(文件读写、命令执行)
  • Git工具(用于获取代码变更)
  • 代码分析能力(AST解析等)

更新日志

v1.0.0 (2026-03-11)

  • 初始版本发布
  • 支持需求符合性检查
  • 支持非必要修改检测
  • 支持代码质量基础检查

反馈与贡献

如有问题或建议,请访问:https://github.com/openclaw/easy-code-review/issues

Reviews (0)

Sign in to write a review.

No reviews yet. Be the first to review!

Comments (0)

Sign in to join the discussion.

No comments yet. Be the first to share your thoughts!

Compatible Platforms

Pricing

Free

Related Configs