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. 01Flowsアプリの技術レビュー実施
  2. 02必須修正後のレビュー再実行
  3. 03デザインレビューと提出用の資料準備

インストール

コマンドをコピーしてターミナルで実行します。

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

インストール後、Claude Code で/flows-code-reviewを入力して読み込まれたか確認します。

詳細

Flows Code Review

このスキルは、技術レビュー手順のローカルランナーです。

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/アプリ概要の事前チェック、フィードバックラウンドのフォルダー、作業ディレクトリがアプリのルートであること、ファイルの書き込み先、および提出者の 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 が含まれる場合):このリポジトリ内にいます。ローカルの skills/flows-review-checks/SKILL.md を Read します(ローカルの code-quality が読み込まれます)。

それ以外の場合(アプリをレビューする場合):このリポジトリからその 2 つのスキルを取得してから、読み込みます。

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

CLI での取得に失敗した場合は、main から同じ 2 つのファイルを取得します。

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. 上記の 4 つのファイルが、このラウンドのフォルダーに存在すること。
  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 に進みます。

コメント