mcpField
C
code-review

code-review

github.com/langchain-ai测试与质量30.8k213 次安装今天更新
代码仓库

关于 code-review

面向开发者和编码 Agent 的代码审查技能,用于在交付前检查改动。它以正确性、代码质量、测试和安全清单配合审查流程,并提供辅助 lint 脚本。

主要功能

  1. 01正确性与边界情况检查清单
  2. 02代码质量审查
  3. 03测试覆盖与执行步骤
  4. 04安全和输入校验检查
  5. 05附带 Python lint 脚本

适用场景

  1. 01交付前审查代码改动
  2. 02检查测试覆盖及错误场景
  3. 03扫描 Python 代码中的常见 lint 问题

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/langchain-ai/deepagents --skill code-review

安装后在 Claude Code 中输入/code-review确认已加载。

附带文件lint_check.py

详细介绍

代码审查 Skill

在完成代码改动后使用此 Skill,以便在交付前验证你的工作。

审查清单

1. 正确性
  • 改动解决了最初的 issue/任务
  • 对现有功能没有非预期的副作用
  • 已处理边界情况
  • 错误处理恰当(不过度)
2. 代码质量
  • 代码符合现有风格和模式
  • 没有不必要的复杂度或抽象
  • 变量和函数名称清晰
  • 没有遗留死代码、被注释掉的代码或 TODO
3. 测试
  • 新功能有测试覆盖
  • 现有测试仍然通过
  • 测试同时覆盖正常路径和错误情况
  • 测试不脆弱(不测试实现细节)
4. 安全
  • 没有硬编码的密钥或凭据
  • 用户输入在边界处经过校验
  • 不存在 SQL 注入、XSS 或命令注入风险
  • 文件操作使用安全路径

流程

  1. 逐个通读每个被修改的文件(而不仅仅是 diff)
  2. 运行测试套件:execute("python -m pytest -v")
  3. 如有可用的 linter,则运行:execute("ruff check .")
  4. 运行随附的 lint 检查:execute("python /skills/code-review/lint_check.py .")
  5. 对照审查清单的每一项进行检查
  6. 如发现任何问题,修复后重新审查
  7. 当所有检查都通过后,审查完成

辅助脚本

  • /skills/code-review/lint_check.py — 扫描 Python 文件,检查缺失的文档字符串、过长的函数(>50 行)以及裸 except: 子句。通过 execute("python /skills/code-review/lint_check.py [path ...]") 运行。

评论

支持 Markdown