返回顶部
c

code-review代码审查模式

Systematic code review patterns covering security, performance, maintainability, correctness, and testing — with severity levels, structured feedback guidance, review process, and anti-patterns to avoid. Use when reviewing PRs, establishing review standards, or improving review quality.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
11,409
下载量
免费
免费
11
收藏
概述
安装方式
版本历史

code-review

代码审查清单

对代码进行彻底、结构化的审查。系统地逐一检查每个维度,而非随机扫描。

安装

OpenClaw / Moltbot / Clawbot

bash
npx clawhub@latest install code-review



审查维度


维度关注点优先级
安全性漏洞、认证、数据泄露关键
性能
速度、内存、可扩展性瓶颈 | 高 |
| 正确性 | 逻辑错误、边界情况、数据完整性 | 高 |
| 可维护性 | 可读性、结构、面向未来 | 中 |
| 测试 | 测试覆盖率、质量、可靠性 | 中 |
| 无障碍性 | WCAG 合规性、键盘导航、屏幕阅读器 | 中 |
| 文档 | 注释、API 文档、变更日志条目 | 低 |


安全性检查清单

审查每个变更是否存在以下漏洞:

  • - [ ] SQL 注入 — 所有查询使用参数化语句或 ORM;不使用用户输入进行字符串拼接
  • [ ] XSS — 用户提供的内容在渲染前已转义/清理;dangerouslySetInnerHTML 或等效用法有正当理由且安全
  • [ ] CSRF 防护 — 改变状态的请求需要有效的 CSRF 令牌;已设置 SameSite Cookie 属性
  • [ ] 认证 — 每个受保护的端点在处理前验证用户已通过身份验证
  • [ ] 授权 — 资源访问范围限定于请求用户的权限;无 IDOR 漏洞
  • [ ] 输入验证 — 所有外部输入(参数、请求头、请求体、文件)在服务器端验证类型、长度、格式和范围
  • [ ] 密钥管理 — 源代码中无 API 密钥、密码、令牌或凭据;密钥来自环境变量或保险库
  • [ ] 依赖安全性 — 新依赖来自可信来源、积极维护且无已知 CVE
  • [ ] 敏感数据 — PII、令牌和密钥绝不记录日志、包含在错误消息中或返回在 API 响应中
  • [ ] 速率限制 — 公共和认证端点具有速率限制以防止暴力破解和滥用
  • [ ] 文件上传安全 — 上传的文件验证类型和大小,存储在 webroot 之外,并使用安全的 Content-Type 标头提供
  • [ ] HTTP 安全标头 — 已设置 Content-Security-Policy、X-Content-Type-Options、Strict-Transport-Security

性能检查清单

  • - [ ] N+1 查询 — 数据库访问模式已批处理或连接;无循环发出单个查询
  • [ ] 不必要的重新渲染 — 组件仅在其相关状态/属性发生变化时重新渲染;在可衡量的地方应用了记忆化
  • [ ] 内存泄漏 — 事件监听器、订阅、定时器和间隔在卸载/销毁时已清理
  • [ ] 打包体积 — 新依赖可进行 tree-shaking;大型库动态加载;不为单个函数导入整个库
  • [ ] 懒加载 — 重型组件、路由和首屏以下内容使用懒加载/代码分割
  • [ ] 缓存策略 — 昂贵计算和 API 响应使用适当的缓存(记忆化、HTTP 缓存标头、Redis)
  • [ ] 数据库索引 — 查询在索引列上进行过滤/排序;新查询已使用 EXPLAIN 检查
  • [ ] 分页 — 列表端点和查询使用分页或基于游标的获取;无无限制的 SELECT *
  • [ ] 异步操作 — 长时间运行的任务卸载到后台作业或队列,而非阻塞请求线程
  • [ ] 图片与资源优化 — 图片尺寸适当,使用现代格式(WebP/AVIF),并利用 CDN 分发

正确性检查清单

  • - [ ] 边界情况 — 处理空数组、空字符串、零值、负数和最大值
  • [ ] Null/Undefined 处理 — 访问前检查可空值;可选链或防护措施防止运行时错误
  • [ ] 差一错误 — 验证循环边界、数组切片、分页偏移和范围计算
  • [ ] 竞态条件 — 对共享状态的并发访问使用锁、事务或原子操作
  • [ ] 时区处理 — 日期以 UTC 存储;显示转换在表示层进行
  • [ ] Unicode 与编码 — 字符串操作处理多字节字符;文本编码明确(UTF-8)
  • [ ] 整数溢出/精度 — 对大数字或货币的算术使用适当类型(BigInt、Decimal)
  • [ ] 错误传播 — 捕获并处理异步调用和外部服务的错误;promise 绝不静默吞没
  • [ ] 状态一致性 — 多步变更具有事务性;部分失败使系统保持有效状态
  • [ ] 边界验证 — 测试有效范围边界处的值(最小值、最大值、恰好达到限制)

可维护性检查清单

  • - [ ] 命名清晰性 — 变量、函数和类具有描述性名称,揭示意图
  • [ ] 单一职责 — 每个函数/类/模块做一件事;对一个关注点的更改不会波及无关代码
  • [ ] DRY — 重复逻辑提取到共享工具中;复制粘贴的代码块已合并
  • [ ] 圈复杂度 — 函数具有低分支复杂度;深度嵌套的链已重构
  • [ ] 错误处理 — 在适当边界捕获错误,记录上下文,并有意义地呈现
  • [ ] 死代码移除 — 移除注释掉的代码、未使用的导入、不可达分支和过时的功能标志
  • [ ] 魔法数字与字符串 — 字面值提取为具有清晰语义的命名常量
  • [ ] 一致的模式 — 新代码遵循代码库中已建立的约定
  • [ ] 函数长度 — 函数足够短,一目了然;长函数已分解
  • [ ] 依赖方向 — 依赖指向内部(基础设施到领域);核心逻辑不导入 UI 或框架层

测试检查清单

  • - [ ] 测试覆盖率 — 新逻辑路径有对应测试;关键路径有快乐路径和失败案例测试
  • [ ] 边界情况测试 — 测试覆盖边界值、空输入、null 和错误条件
  • [ ] 无不稳定测试 — 测试是确定性的;不依赖时序、外部服务或共享可变状态
  • [ ] 测试独立性 — 每个测试设置自己的状态并清理;测试顺序不影响结果
  • [ ] 有意义的断言 — 测试断言行为和结果,而非实现细节
  • [ ] 测试可读性 — 测试遵循 Arrange-Act-Assert;测试名称描述场景和预期结果
  • [ ] 模拟纪律 — 仅模拟外部边界(网络、数据库、文件系统)
  • [ ] 回归测试 — 错误修复包含一个复现原始错误并证明已解决的测试

审查流程

分三轮审查代码。不要试图在一次阅读中发现所有问题。

轮次关注点时间寻找什么
第一轮高层结构2-5 分钟架构适配性、文件组织、API 设计、整体方法
第二轮
逐行细节 | 主要时间 | 逻辑错误、安全问题、性能问题、边界情况 |
| 第三轮 | 边界情况与加固 | 5 分钟 | 故障模式、并发、边界值、缺失测试 |

第一轮(2-5 分钟)

  1. 1. 阅读 PR 描述和关联问题
  2. 扫描文件列表 — 变更范围是否合理?
  3. 检查整体方法 — 这是解决问题的正确方案吗?
  4. 验证变更不会引入架构漂移

第二轮(主要审查时间)

  1. 1. 从上到下阅读每个文件差异
  2. 对照上述清单检查每个函数变更
  3. 验证每个 I/O 边界的错误处理
  4. 标记任何让你停顿的内容 — 相信你的直觉

第三轮(5 分钟)

  1. 1. 思考生产环境中可能出现的问题
  2. 检查你标记的代码路径上是否缺失测试
  3. 验证回滚安全性 — 此变更能否在不丢失数据的情况下回退?
  4. 确认文档和变更日志在需要时已更新

严重级别

为每条评论分类严重级别,以便作者知道哪些会阻塞合并。

级别标签含义阻塞合并?
关键[CRITICAL]安全漏洞、数据丢失或生产环境崩溃
主要
[MAJOR] | 错误、逻辑错误或显著性能回归 | 是 |
| 次要 | [MINOR] | 可减少未来维护成本的改进 | 否 |
| 细节 | [NIT] | 风格偏好、命名建议或琐碎

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 code-review-1776300199 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 code-review-1776300199 技能

通过命令行安装

skillhub install code-review-1776300199

下载

⬇ 下载 code-review v1.0.0(免费)

文件大小: 7.02 KB | 发布时间: 2026-4-16 16:38

v1.0.0 最新 2026-4-16 16:38
Initial release of the code-review skill with comprehensive, structured checklists for code review.

- Provides detailed checklists for security, performance, correctness, maintainability, and testing.
- Suggests severity and priority for each review dimension.
- Outlines best practices, anti-patterns to avoid, and a step-by-step review process.
- Includes sample installation instructions.
- Aims to standardize and improve code review quality for any team.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部