Requesting Code Review Skill logo

Requesting Code Review Skill

打开

调度代码审查 subagent 在问题级联前捕获 - 尽早审查,经常审查。

分享:

请求代码审查

来自 Superpowers 项目的代码审查请求 Skill,通过调度代码审查 subagent 在问题级联前捕获缺陷。该 Skill 强调"尽早审查,经常审查"的原则,通过系统化的代码审查维护高代码质量。

核心原则

尽早审查,经常审查:不要等到所有代码完成后才进行审查。在开发过程中频繁进行小规模审查,及时发现和修复问题。

何时请求审查

强制性审查时机

Subagent 驱动开发中每个任务后:在使用 subagent 完成每个开发任务后,立即请求代码审查。确保每个任务的代码质量,防止问题累积。

完成主要功能后:在完成一个主要功能或模块后进行审查。验证功能的正确性、代码质量和设计合理性。

合并到 main 前:在将代码合并到主分支前,必须进行最终审查。这是质量控制的最后一道防线,确保进入主分支的代码符合标准。

可选但有价值的审查时机

卡住时(需要新视角):当遇到技术难题或设计困境时,请求审查获取新的视角。审查者可能提供不同的解决思路或发现被忽略的问题。

重构前(基线检查):在进行大规模重构前,审查现有代码建立基线。确保理解当前代码的设计意图和潜在问题。

修复复杂 bug 后:在修复复杂或关键 bug 后进行审查。验证修复的正确性,确保没有引入新问题。

审查优势

尽早捕获问题:在问题扩散和级联前发现缺陷。早期发现的问题修复成本低,影响范围小。

提供新视角:审查者带来不同的视角和经验。可能发现开发者忽略的问题或提出更好的解决方案。

确保代码质量:系统化的审查确保代码符合质量标准。包括代码风格、设计模式、性能、安全性等方面。

防止级联问题:避免小问题演变成大问题。早期修复防止问题在后续开发中被放大。

知识共享:审查过程促进团队成员间的知识共享。审查者了解代码库的变化,开发者学习最佳实践。

审查流程

  1. 完成代码:完成一个任务或功能的开发
  2. 自我检查:开发者先进行自我审查,修复明显问题
  3. 请求审查:使用该 Skill 调度代码审查 subagent
  4. 审查执行:Subagent 分析代码,识别问题和改进点
  5. 处理反馈:根据审查意见修改代码
  6. 验证修复:确认所有问题已解决

审查重点

代码质量:检查代码的可读性、可维护性、复杂度。识别代码异味和潜在的重构机会。

功能正确性:验证代码是否正确实现了需求。检查边界条件、错误处理和异常情况。

性能问题:识别潜在的性能瓶颈。检查算法复杂度、资源使用等。

安全性:发现安全漏洞和风险。检查输入验证、权限控制、数据保护等。

测试覆盖:评估测试的充分性和有效性。确保关键路径和边界情况都有测试覆盖。

应用价值

该 Skill 通过强制和鼓励频繁的代码审查,显著提升代码质量。早期和频繁的审查使问题在影响范围小时就被发现和修复,大幅降低了后期修复的成本。

对于使用 subagent 驱动开发的团队,该 Skill 确保每个 subagent 生成的代码都经过审查。这种系统化的方法防止了质量问题的累积,保持了代码库的整体健康。

通过提供新视角和促进知识共享,代码审查不仅提升了代码质量,也促进了团队成员的成长和协作。

评论

还没有评论。成为第一个评论的人!