用途:code-review-checklist 是一个面向代码审查的技能,提供系统化清单,帮助审查者确保代码质量、发现缺陷、识别安全问题并保持代码库一致性。资料说明其适用于审查拉取请求、开展代码审计、为团队建立代码审查标准、培训新开发者、避免审查遗漏,以及编写代码审查文档。
主要能力:该技能按六个步骤组织审查。第一步理解上下文,包括代码解决什么问题、需求是什么、改了哪些文件及原因、有无相关工单、测试策略是什么。第二步审查功能,检查是否解决既定问题、边界情况与错误处理是否恰当、有无逻辑错误、是否符合需求。第三步审查代码质量,关注可读性、命名、结构、函数聚焦度与不必要的复杂度。第四步审查安全,检查输入校验、敏感数据保护、SQL 注入风险、认证授权与依赖安全。第五步审查性能,关注不必要循环、数据库访问优化、内存泄漏、缓存使用与 N+1 查询。第六步审查测试,确认新代码有测试、覆盖边界情况、测试有意义、全部通过且覆盖率足够。资料还为功能、安全、代码质量分别给出清单示例和正反代码对比,例如缺少输入校验与正确校验的对比、字符串拼接 SQL 与参数化查询的对比、硬编码密钥与环境变量读取的对比、命名不清与描述性命名的对比、函数职责过多与关注点分离的对比。
使用方式:审查时先阅读 PR 描述与关联问题,确认 CI 测试通过,并尽量拉取分支在本地运行。随后按完整清单逐项核对:功能、安全、性能、代码质量、测试、文档与 Git 规范(提交信息清晰、无合并冲突、分支与主分支同步、未提交无关文件、.gitignore 配置正确)。资料建议审查小改动、先看测试、运行代码、多提问、给出建设性意见、聚焦重要问题、使用自动化工具、检查文档更新、考虑性能与回归。应避免未阅读就批准、反馈含糊、忽略安全、跳过测试、态度粗鲁、走过场、疲劳审查和脱离上下文。资料还提供请求修改、提问和表扬优质代码的评论模板,并列出常见问题及应对,如缺失边界情况时多问“如果输入为空、数组为空、用户未认证、网络请求失败会怎样”,安全漏洞可用扫描器与 OWASP Top 10 检查,测试不足则要求单元、集成、边界与错误测试,代码不清则请求改进命名、注释、拆分函数和清晰结构。
适用场景:拉取请求审查、代码审计、团队审查规范制定、新开发者培训、审查文档编写。
限制:资料提示仅当任务明确匹配上述范围时使用该技能;其输出不能替代针对具体环境的验证、测试或专家审查;当缺少必要输入、权限、安全边界或成功标准时,应停止并寻求澄清。