工程开发
structured-code-review avatar

structured-code-review

执行结构化的五阶段代码审查,涵盖需求合规性、正确性、代码质量、测试与安全性。提供分类后的具体改进建议(严重/主要/次要/微调)。

简介

结构化代码审查技能通过严谨的多阶段方法论,彻底改变了 AI 代理评估合并请求 (PR) 的方式。该技能取代了单一、无结构的扫描,强制执行系统化的检查流程,确保代码质量的各个面向都不被忽略。它专为开发人员、软件工程师和需要维护高标准协作环境的自动化代理而设计,确保每个提交的代码都具备可靠性、可维护性与安全性。

  • 执行五个区分检查流程:需求合规性、正确性、代码质量、测试与安全性/性能。

  • 在每个阶段使用针对性的检查清单,以捕捉逻辑错误、需求蔓延、命名不一致、边缘情况处理,以及诸如 SQL 注入或泄漏密钥等安全漏洞。

  • 将反馈分为明确的等级:Blocker (必须修正)、Major (建议修正)、Minor (建议) 与 Nit (风格/微小问题)。

  • 提供标准且可执行的反馈模板,标识问题、解释重要性并提供具体的改进方案。

  • 包含一份完整的审查清单摘要 (Review Checklist Summary),确保每次审查结束时的报告一致性。

  • 与其他专业工程技能(如验证门槛、测试模式与反模式分析)集成,建立具备一致性的开发工作流程。

  • 当您要求代理 'review my code'、'check this PR'、'review my changes' 或 'provide code feedback' 时即可触发此技能。

  • 当您需要确保代码符合项目约定、满足功能需求并通过安全审核时,请务必使用此技能。

  • 输出的格式对开发人员非常友好,鼓励直接进行可执行的修改,而非仅提供模糊的观察。

  • 非常适合作为合并前检查阶段使用,以预防回归错误并减少技术债。

  • 在清晰、模块化的代码库中效果最佳;特别擅长发现缺失的边缘情况处理与次优的架构抽象。

仓库统计

Star 数
916
Fork 数
87
Open Issue 数
6
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 04:36
在 GitHub 查看