mcpField
R
review-spec

review-spec

github.com/ferueda测试与质量285 次安装19 周前更新
代码仓库

关于 review-spec

review-spec 是一项代码审查技能,用于对照规范与相关代码库进行评估,帮助团队发现设计、可行性、安全性和测试问题,并给出优先级明确的改进建议。

主要功能

  1. 01对照规范与代码库
  2. 02检查架构与可行性
  3. 03评估可靠性、安全性和性能
  4. 04发现边界情况与测试缺口
  5. 05整理优先级明确的建议

适用场景

  1. 01审查拟定的实现计划
  2. 02检查规范是否符合现有代码
  3. 03开发前发现安全或可靠性风险

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/ferueda/agent-skills --skill review-spec

安装后在 Claude Code 中输入/review-spec确认已加载。

详细介绍

审查给定的规范文档,同时分析规范和引用的代码库。

流程

  1. 阅读规范——了解目标、阶段和拟议的变更
  2. 探索代码库——阅读规范中提及的文件和代码
  3. 分析模式——识别现有模式、约定和架构
  4. 验证计划——确保提案符合代码库的实际情况
  5. 发现问题——找出缺漏、风险和改进机会

审查维度

从以下方面进行评估(重点关注相关内容):

  • 架构:组件边界、数据流、API 契约、关注点分离
  • 可行性:实现复杂度、技术权衡、工作量估算
  • 可靠性:错误处理、重试、幂等性、优雅降级
  • 性能:瓶颈、缓存、查询模式、扩展方案
  • 安全性:身份验证、数据保护、输入验证、审计日志
  • 边缘情况:空值处理、限制、超时、竞态条件、部分故障
  • 测试:可测试性、集成策略、回滚注意事项

输出格式

针对每项发现:

### [Finding Title]

**Category**: Architecture | Feasibility | Reliability | Performance | Security | Edge Case | Testing
**Severity**: Critical | High | Medium | Low
**Section**: [Spec section or phase]

**Issue**: [Clear problem description]
**Recommendation**: [Specific, actionable change]
**Rationale**: [Technical justification]

指南

  • 对照代码验证——不要盲目相信规范;检查实际实现
  • 遵循现有模式——建议应符合代码库的惯例
  • 具体明确——引用确切的文件、函数和行号
  • 确定优先级——按严重程度和影响排序发现
  • 质疑假设——审视缺乏依据的决策

评论

支持 Markdown