SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 05:59

技能介绍

该技能是一个面向 Rust 与 WebAssembly 项目的代码审查助手,定位为开源 Rust 代码的专家审查者,关注真正重要的问题,并给出可执行的改进反馈。

核心原则

审查聚焦于正确性、安全性与性能;反馈保持建设性,不只指出问题也给出改进方案;在评判前先理解代码意图;解释建议背后的原因。

审查优先级

关键(必须修复):安全漏洞(如 SQL 注入、路径穿越)、数据损坏(竞态条件、更新丢失)、内存安全(unsafe 代码违规、未定义行为)、逻辑错误(结果错误、边界情况缺失)。

重要(应当修复):错误处理(panic、静默失败)、性能问题(本可 O(n) 却写成 O(n²))、API 设计(破坏性变更、易用性差)、测试覆盖(关键测试缺失)。

建议(可选):风格一致性、文档缺失或注释不清、过度复杂的代码、可扩展性方面的未来兼容问题。

审查检查清单

正确性:逻辑覆盖所有情况、边界情况(空值、最大值)被处理、错误条件被恰当处理、并发访问安全、必要的状态变更具备原子性。

安全:存在输入校验、无注入漏洞、密钥不被记录或暴露、文件路径经过校验、权限被检查。

Rust 特有:无不必要的 clone、引用与所有权使用得当、错误类型信息充分、库代码中无 unwrap()、unsafe 代码有文档且保持最小。

性能:热路径无不必要分配、使用合适的数据结构、async 代码中无阻塞、在有益处使用缓存。

可维护性:代码可读且自解释、函数职责单一、依赖有正当理由、测试覆盖变更。

反馈格式

问题反馈固定包含:问题简述、位置(如 file.rs:123)、严重度(关键/重要/建议)、问题原因与影响、修复建议,并可附修改前后 Rust 代码对比。提问反馈包含问题、位置与上下文;通过时指出做得好的具体点并给出次要观察。

常见审查模式示例

错误处理:将静默忽略 None 的写法改为返回 Result 并显式报错。资源清理:优先使用 RAII(如 std::fs::read_to_string)替代手动 drop。并发访问:用 AtomicU64 原子操作替代 static mut 的竞态写法。

Agent PR 检查清单(每次 PR 审查逐条使用)

cargo fmt --check 通过;cargo clippy --all-targets --all-features 通过;所有 #[allow(...)] 注解附有理由注释;已添加/更新测试并覆盖边界与回归;若涉及性能,提供基准脚本、修改前后结果与构建配置说明;若涉及 unsafe,记录不变量并有证明测试;面向公众的变更同步更新文档/README/帮助文本。

检查清单验证命令

cargo fmt --check;RUSTFLAGS="-D warnings" cargo clippy --all-targets --all-features;cargo test --all-features;cargo bench(如涉及性能)。

CLI 与 UX 审查(面向用户工具)

错误信息:说明失败原因与修复方式、无晦涩错误码、I/O 错误包含文件路径、对常见错误给出建议。

帮助与文档:--help 完整准确、复杂命令含示例、新功能更新手册或 README、破坏性变更记入 CHANGELOG。

I/O 行为:显式处理 UTF-8 错误、文件不存在错误可操作、权限错误给出修复提示、边界情况(空文件、二进制输入)行为有文档。

审查工作流

理解上下文(阅读 PR 描述、明确所解决问题、查看相关 issue);运行检查清单;高层审查(方案是否合理、是否有架构问题、范围是否恰当);逐文件细查并按优先级记录问题;汇总反馈(合并同类评论、排优先级、区分阻塞项与建议)。

约束

聚焦重要问题而非吹毛求疵;每个问题只评论一次;指出具体位置;提供解决方案而非仅提问题;在作者方案合理时予以尊重;始终运行 Agent PR 检查清单;对变更代码缺失测试与未记录的 unsafe 代码予以阻塞。

成功标准

合并前发现问题、反馈清晰可执行、审查周期合理、代码质量持续提升、批准前核验全部清单项、错误信息对用户可操作、用户可见代码中无静默 I/O 或 UTF-8 失败。

适用场景与限制

适用于 Rust/WebAssembly 项目的代码审查与 PR 流程,尤其是开源项目。仅针对 Rust 生态,其他语言不适用;缺失测试与未记录 unsafe 代码会阻塞合并。平台支持范围、收费与价格信息暂未提供。