Open Skills Logo
Open Skills

code-review-and-quality

进行多维度代码审查。在合并任何变更之前使用。在审查由自己、其他代理或人类编写的代码时使用。在代码进入主分支之前，用于从多个维度评估代码质量。

作者

@addyosmani

分类

开发工具

安装

热度:21

下载并解压到你的 skills 目录

复制命令，发送给智能体自动安装：

下载并安装这个技能 https://openskills.cc/api/download?slug=addyosmani-skills-code-review-and-quality&locale=zh&source=copy

代码审查与质量 - 多维度代码质量评估技能

技能概述


代码审查与质量技能提供系统的五轴代码审查框架，帮助开发者在合并前全面评估代码的正确性、可读性、架构、安全性和性能，建立有效的代码质量门禁。

适用场景

1. 合并前代码审查


在提交 Pull Request 或合并代码之前进行系统性审查，确保所有变更都经过质量检查。这个技能提供了清晰的审查流程和评估标准，帮助团队建立一致的代码审查规范。

2. AI 生成代码审查


当使用 AI 工具（如 Claude、GPT 等）生成代码后，需要进行更严格的审查。AI 生成的代码看起来正确但可能存在隐患，这个技能提供了针对性的审查要点和多模型协作审查模式。

3. 重构和 Bug 修复审查


代码重构和 Bug 修复往往引入新的问题。这个技能不仅审查修复本身，还检查是否引入了架构问题、性能瓶颈或安全漏洞，同时识别可以清理的死代码。

核心功能

五轴代码审查框架


从五个维度全面评估代码质量：
  • 正确性：检查代码是否符合需求、是否处理边界情况和错误路径

  • 可读性：评估代码是否易于理解、命名是否清晰、逻辑是否简洁

  • 架构：审查代码是否合理分解、是否过度设计、是否减少而非转移复杂度

  • 安全性：检查输入验证、权限控制、依赖管理等安全要点

  • 性能：识别 N+1 查询、无界循环、不必要的同步操作等性能问题

    • 结构化建议和修复方案


    当发现代码问题时，不仅指出问题所在，还提供具体的重构建议：
  • 用类型模型替换条件链

  • 折叠重复分支为单一流程

  • 将编排与业务逻辑分离

  • 重用现有规范助手而非定制重复方案

  • 明确类型边界以简化下游控制流

    • 变更大小和依赖管理


    提供 PR 大小的最佳实践指南和依赖审查流程：
  • 推荐每次变更约 100 行代码，超过 1000 行应拆分

  • 检查文件总行数而不仅仅是变更行数

  • 逐个审查依赖升级，阅读变更日志而非仅看版本号

  • 审查 lockfile 差异，关注传递性依赖变化

  • 防止批量依赖升级掩盖问题根源

    • 常见问题

    代码审查应该检查哪些内容？


    代码审查应覆盖五个维度：正确性（代码是否实现需求、处理边界情况）、可读性（命名是否清晰、逻辑是否简单）、架构（是否合理分解、没有过度设计）、安全性（输入验证、权限控制、无注入漏洞）、性能（无 N+1 查询、无界循环）。不要只检查测试是否通过，测试是必要但不充分的。

    如何处理代码审查中的分歧？


    处理代码审查分歧时应遵循层次结构：技术事实和数据优先于观点和偏好；风格指南是风格问题的绝对权威；软件设计必须基于工程原则而非个人偏好；如果改动不降低整体代码健康状况，保持代码库一致性是可以接受的。不要接受"以后再清理"，经验表明延后的清理很少发生。

    代码审查的严重程度如何标注？


    使用清晰的标签区分问题优先级：无前缀表示必须修改的 Required 问题；Critical 表示阻止合并的严重问题（安全漏洞、数据丢失、功能损坏）；Nit 表示可选的样式问题；Optional/Consider 表示值得考虑的建议；FYI 表示仅供未来参考的信息。这样作者可以区分必须修复和可选建议，提高审查效率。