SuperAPI AI 工具集

project-audit

测试与质量

查看项目

更新于 10-16 04:40

技能介绍

用途

Project Audit 是一个项目健康审计技能,用于对代码库进行确定性评分,帮助评估项目质量、接手新代码库或进行定期健康检查。它明确不适用于安全专项审查(应使用 /codex-security)、运行时性能分析,以及开发中期评审(应使用 /codex-review-fast)。

主要能力

该技能通过运行审计脚本执行 12 项确定性检查,覆盖 5 个维度:

  • oss(开源规范):2 项检查,衡量 LICENSE 和 README 质量。
  • robustness(健壮性):3 项检查,衡量 CI 配置、lint/typecheck、测试比例。
  • scope(范围):2 项检查,衡量声明功能与实现的一致性、AC 完成度。
  • runnability(可运行性):3 项检查,衡量包清单、脚本、环境/Docker 设置。
  • stability(稳定性):2 项检查,衡量锁文件与审计、类型配置。

评分模型:每项检查得分为 1(通过)/ 0.5(部分)/ 0(失败)/ N/A(跳过)。维度得分 = 适用项得分之和 / 适用项数量 × 100。总分 = 各维度得分的平均值。置信度 = 每个维度的适用检查数 / 总检查数。

状态判定:

  • Blocked:存在任何 P0 发现,退出码 2。
  • Needs Work:无 P0,存在 P1,退出码 1。
  • Healthy:无 P0/P1,退出码 0。

使用方式

运行以下命令收集确定性评分:

bash scripts/run-skill.sh project-audit audit.js --json

解析 JSON 输出,包含 overall_score、status、dimensions、checks、findings、next_actions。根据状态处理:

  • 若 status = Blocked(P0 发现),突出关键缺口,建议立即修复。
  • 若 status = Needs Work(P1 发现),按维度格式化改进路线图。
  • 若 status = Healthy,总结优势,注明任何 P2 改进项。

在分数之外添加定性解读(例如“测试比例良好但集中在单元测试”)。

若脚本失败,报告错误并建议手动运行上述命令。

输出格式为项目审计报告,包含仓库名、分数、状态、维度表格、检查结果列表(含建议)和按优先级排列的后续行动,以及 Gate 标记(✅/⛔)。

适用场景

  • 评估项目质量
  • 接手新代码库时的入门审查
  • 定期健康检查

限制

  • 不适用于安全专项审查、运行时性能分析、开发中期评审。
  • 依赖审计脚本成功运行;脚本失败时需手动运行。
  • 检查项为确定性检查,需额外添加定性解读。

参考资料

  • references/check-catalog.md:检查定义、评分标准、生态系统检测(调查特定检查结果时阅读)。
  • references/output-template.md:报告格式示例和 JSON schema(自定义输出时阅读)。

验证

  • 脚本成功运行。
  • 所有 12 项检查已执行(或标记 N/A 并说明原因)。
  • 在原始分数之外添加了定性解读。
  • 后续行动可操作(适用时包含命令)。