SuperAPI AI 工具集

code-review-checklist

测试与质量

查看项目

更新于 10-16 05:51

技能介绍

用途:为代码评审提供系统化检查清单,帮助评审者保证代码质量、发现缺陷、识别安全问题并保持代码库一致性。适用于审查 Pull Request、代码审计、制定团队评审规范、培训新人、编写评审文档,或希望评审中不遗漏要点时使用。\n\n主要能力:按步骤引导评审。第一步理解上下文,明确代码解决什么问题、需求是什么、改了哪些文件及原因、相关 issue 与测试策略。第二步检查功能:是否正确解决问题、边界情况与错误处理、输入校验、逻辑错误、是否符合需求。第三步检查代码质量:可读性、命名是否描述性、结构是否合理、函数是否聚焦、是否存在不必要复杂度。第四步检查安全:输入校验、敏感数据保护、SQL 注入风险、认证授权、依赖安全。第五步检查性能:不必要循环、数据库访问优化、内存泄漏、缓存使用、N+1 查询。第六步检查测试覆盖:新代码是否有测试、是否覆盖边界、测试是否有意义、是否全部通过、覆盖率是否足够。\n\n用法:评审前阅读 PR 描述与关联 issue,确认 CI 测试通过,拉取分支本地运行。逐项对照清单,包括功能、安全、性能、代码质量、测试、文档和 Git 提交规范。可套用其评审意见模板提出修改建议、提问和肯定优秀代码。常见陷阱包括遗漏边界情况、安全漏洞、测试覆盖不足和代码晦涩,资料给出对应处理思路。\n\n限制:该技能为清单与流程指导,不提供自动扫描或修复能力;具体语言、框架、团队规范需自行定制。资料未说明收费、价格或平台信息。