mcpField
R
review-as-json

review-as-json

github.com/elliottlawsonテスト・品質0330 回インストール12 週間前に更新
リポジトリ

review-as-json について

review-as-jsonは、`/review`を実行し、文章形式のレポートではなく単一のJSONオブジェクトで結果を返すコードレビュー用スキルです。判定、重大度、指摘の種類やカテゴリなどを定型化します。

主な機能

  1. 01`/review`プロセスの実行
  2. 02単一JSONオブジェクトでの出力
  3. 03判定と重大度の分類
  4. 04レビュー工程ごとの指摘分類
  5. 05具体的な根拠のある指摘

活用シーン

  1. 01機械可読なコードレビューの生成
  2. 02レビュー結果のCI出力への受け渡し
  3. 03検証済みの問題や質問の報告

インストール

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

$npx skills add https://github.com/elliottlawson/open-review --skill review-as-json

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

詳細

JSON としてレビューする

この変更に対して /review を実行し、その指示に厳密に従ってください。

レポートを文章で出力する代わりに、単一の JSON オブジェクトとして結果を出力してください。

{
  "verdict": "approve | changes_needed | hold",
  "summary": "One or two sentences on the change overall.",
  "findings": [
    {
      "severity": "critical | warning | info",
      "type": "issue | suggestion | question",
      "category": "mission | architecture | implementation | craft | security | performance",
      "title": "Short imperative, e.g. 'Sanitize user input before query'",
      "description": "What it is, why it matters, and the consequence.",
      "file": "path/to/file.ts",
      "line": 42,
      "suggestedFix": "Optional concrete fix."
    }
  ],
  "passes": {
    "mission": "met | missing | different | unclear",
    "architecture": "ok | concern | blocking",
    "implementation": "ok | concern | blocking",
    "craft": "ok | concern | blocking",
    "security": "ok | concern | blocking",
    "performance": "ok | concern | blocking"
  },
  "sectionSummaries": {
    "mustFix": "1-2 sentences on the critical findings, if any.",
    "shouldFix": "1-2 sentences on the warnings, if any.",
    "questions": "1-2 sentences on the questions, if any.",
    "suggestions": "1-2 sentences on the suggestions, if any."
  }
}

出力ルール:

  • JSON オブジェクトのみを出力してください。前置き、コメント、Markdown のコードフェンスは付けないでください。
  • 重大度。 critical はマージを阻止します(バグ、セキュリティ上の欠陥、データ損失)。warning は対処すべきですが、マージを阻止するものではありません。info は補足情報です。
  • 概要。 結論を繰り返さないでください(「この PR は承認されました」「変更が必要です」など)。概要では、その理由を説明します。
  • sectionSummaries。 根本的なテーマを説明してください(「新しいエンドポイント全体で入力検証が欠けています」など)。指摘の件数だけを述べないでください。
  • タイプ。 question は、不具合ではなく回答が必要なものです。suggestion は任意の改善提案です。それ以外はすべて issue です。
  • カテゴリ。 各指摘の category は、その指摘を発見したパスです。これにより、CI 出力で各パスの結果を確認できます。
  • 報告する前に検証してください。 各指摘には、具体的なファイル、行、影響が必要です。検証できない場合は、question にしてください。
  • 指摘がない場合は、空の findings 配列と approve 判定を出力してください。

コメント