mcpField
F
flows-code-review

flows-code-review

github.com/cognitedata测试与质量61.6k 次安装1 天前更新
代码仓库

关于 flows-code-review

flows-code-review 是用于 Cognite Flows 应用认证技术审查阶段的技能。它管理审查轮次、获取最新检查项,并规定报告文件及需记录的审批状态。

主要功能

  1. 01检查仓库和应用简报前置条件
  2. 02选择下一反馈轮次
  3. 03获取最新审查检查项
  4. 04编写审查文件和评分报告
  5. 05在摘要中记录未解决问题

适用场景

  1. 01对 Flows 应用进行技术审查
  2. 02修复必须项后重复审查
  3. 03为设计审查和提交准备材料

安装

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

$npx skills add https://github.com/cognitedata/builder-skills --skill flows-code-review

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

详细介绍

Flows 代码审查

此技能是技术审查步骤的本地运行器:

flows-app-brief  →  build  →  flows-code-review (this skill, repeat until clean)  →  flows-design-review  →  flows-external-app-submit

检查项和评分规则位于 flows-review-checks 中。 不要在此处复制它们。不要凭记忆评分。不要用 test-coverage 或其他修复技能替代审查标准。

此文件只决定:git/app-brief 预检查、反馈轮次文件夹、确保工作目录是应用根目录、文件写入位置,以及提交者 Summary 块。

预检查

  • 存在 package.json
  • 当前位于 git 仓库中(git rev-parse --git-dir)
  • 如果仓库根目录缺少 App-Brief.md,则警告应先运行 flows-app-brief,但继续执行

反馈轮次:查看 reviews/code-review/。如果该目录不存在,则使用 feedback-round-1/。否则使用下一个不存在的轮次编号。

所有审查命令的工作目录:仓库根目录(应用)。

步骤 1 — 从 cognitedata/builder-skills 获取最新检查项,然后运行

每次审查都必须先从 cognitedata/builder-skills 获取**flows-review-checks 和 code-quality**。不要使用应用 skills/ 文件夹中已有的副本进行评分。

如果当前工作区本身就是 builder-skills(git remote 包含 cognitedata/builder-skills):你就在该仓库中 — Read 本地的 skills/flows-review-checks/SKILL.md(它会加载本地的 code-quality)。

否则(正在审查应用):从此仓库获取这两个技能,然后读取:

npx @cognite/cli@latest apps skills pull --skill flows-review-checks
npx @cognite/cli@latest apps skills pull --skill code-quality

如果 CLI 获取失败,则从 main 获取相同的两个文件:

curl -fsSL https://raw.githubusercontent.com/cognitedata/builder-skills/main/skills/flows-review-checks/SKILL.md
curl -fsSL https://raw.githubusercontent.com/cognitedata/builder-skills/main/skills/code-quality/SKILL.md

然后执行 Glob '**/skills/flows-review-checks/SKILL.md',并对第一个匹配项执行 Read(成功获取后,这就是刚获取的副本)。完整遵循其中的要求:搜查(包括 code-quality 搜索 — 不要应用其中的修复)、包、覆盖率、评分、分类、共享验证。

步骤 2 — 在此处写入产物

轮次目录:reviews/code-review/feedback-round-<N>/

共享输出此处的文件名
文件清单review-files.md
搜查结果 + must/should/nicereview-findings.md
包审计review-packages.md
评分报告code-review-report.md

code-review-report.md 必须包含 flows-review-checks 要求的所有内容(已执行的检查、覆盖率范围、评分 1.1 和 1.3–1.6、2.1–2.6、3.1、must/should/nice,其中 Must Fix 项需带 _Impact:_),以及:

# [App name] — Flows code review

This document is the platform review for [App name], conducted as part of the Cognite Flows app certification process.

## Path to approval

This review found **[N] must-fix item(s)** that block approval. Once the must-fix items are addressed, re-run `flows-code-review`.

### Reviewed commit
`<full SHA>`

在 code-review-report.md 末尾添加以下代码块(flows-external-app-submit 要求):

## Summary

- Must Fix open: <integer>
- Should Fix open: <integer>
- Nice Fix open: <integer>

请准确使用这些标签。解决所有 Must Fix 项后:Must Fix open: 0。

步骤 3 — 运行器验证

完成 flows-review-checks 步骤 6 后:

  1. 上述四个文件均存在于本轮文件夹中。
  2. 本次运行在评分前从 cognitedata/builder-skills 获取了当前版本的 flows-review-checks 和 code-quality(或者在 builder-skills 中已具备这两个技能)。
  3. 输出:
Must Fix open: <n>
Should Fix open: <n>
Nice Fix open: <n>

何时停止

反复运行此技能,直到最新轮次的 code-review-report.md 中出现 Must Fix open: 0。之后才能继续执行 flows-design-review。

评论

支持 Markdown