SuperAPI AI 工具集

code-review-excellence

编程与开发

查看项目

更新于 10-16 04:01

技能介绍

用途

Code Review Excellence 是一个用于提升代码评审质量的 AI 技能。它的核心目标是把代码评审从单纯的“把关审查”转变为团队内的知识共享与协作改进,帮助评审者提供建设性反馈、尽早发现缺陷、维护团队士气。

主要能力

该技能围绕评审流程与方法论提供系统化指导,主要内容包括:

核心原则

  • 评审心态:明确代码评审的目标(捕获缺陷与边界情况、保证可维护性、团队知识共享、执行编码规范、改进设计与架构、建设团队文化),以及不应追求的目标(炫耀知识、纠结格式、无必要地阻塞进度、按个人偏好重写)。
  • 有效反馈:要求反馈具体、可执行、有教育意义、对事不对人、平衡(也包含肯定)、有优先级。资料中给出了正反示例,例如“This is wrong.”与“This could cause a race condition when multiple users access simultaneously. Consider using a mutex here.”的对比。
  • 评审范围:应评审逻辑正确性与边界情况、安全漏洞、性能影响、测试覆盖与质量、错误处理、文档与注释、API 设计与命名、架构契合度;不应手动评审代码格式、导入组织、lint 违规、简单拼写错误。

四阶段评审流程

  1. 上下文收集(2-3 分钟):阅读 PR 描述与关联 issue、检查 PR 规模(超过 400 行建议拆分)、查看 CI/CD 状态、理解业务需求、记录相关架构决策。
  2. 高层评审(5-10 分钟):关注架构与设计、文件组织、测试策略。
  3. 逐行评审(10-20 分钟):关注逻辑与正确性、安全、性能、可维护性。
  4. 总结与决策(2-3 分钟):总结关键问题、指出优点、给出明确决定(批准、评论、请求修改)、复杂问题可提议结对。

评审技术

  • 清单法:提供安全清单、性能清单、测试清单。
  • 提问法:用提问代替直接指出问题,例如“What happens if items is an empty array?”。
  • 建议而非命令:使用协作式语言,并提供示例代码。
  • 严重程度分级:blocking、important、nit、suggestion、learning、praise,并配有示例。

语言特定检查

资料给出了 C#/.NET 与 TypeScript/JavaScript 的评审示例,包括异步/等待使用、异常捕获范围、静态字段线程安全、资源释放、any 类型、异步错误处理、props 变更等问题及改进写法。

高级评审模式

  • 架构评审:先设计文档、分阶段评审、考虑替代方案。
  • 测试质量评审:关注测试行为而非实现细节、测试命名、边界覆盖、独立性、可任意顺序运行。
  • 安全评审:涵盖认证与授权、输入验证、数据保护的检查清单。

困难反馈与分歧处理

提供“上下文 + 具体问题 + 有帮助的解决方案”的反馈模式;当作者不同意时,建议先理解、认可合理观点、提供数据、必要时升级、知道何时放手。

最佳实践与常见陷阱

建议及时评审(24 小时内)、限制 PR 规模(200-400 行)、分时间段评审(每次不超过 60 分钟)、使用评审工具、尽可能自动化、建立融洽关系、保持可联系、向他人学习。常见陷阱包括完美主义、范围蔓延、标准不一致、评审延迟、请求修改后消失、橡皮图章式批准、纠结琐碎细节。

模板与资源

包含 PR 评审评论模板(总结、优点、必须修改、建议、问题、结论),以及参考资料文件(评审最佳实践、常见缺陷清单、安全评审指南)、资产文件(PR 评审模板、评审清单)和脚本 scripts/pr-analyzer.py(分析 PR 复杂度并建议评审者)。

使用方式

该技能作为 AI 技能使用,适用于代码评审相关任务。资料中未提供具体的安装命令或调用示例,暂未提供安装与集成细节。

适用场景

资料列出的适用场景包括:评审拉取请求与代码变更、为团队建立代码评审标准、通过评审指导初级开发者、进行架构评审、创建评审清单与指南、改进团队协作、缩短代码评审周期、维护代码质量标准。

限制

资料未提供关于定价、支持的平台、部署方式、性能指标或集成工具的说明,暂未提供这些信息。