Standard Review Policy for Midstream · v0.1.0 · 2026-06-29 · sha256 321561ded181dba0
Standard Review Policy for Midstream v0.1.0A
Immutable. This exact content is served forever at /api/v1/blob/321561ded181dba0.
--- id: 'review-policy-standard-midstream' name: 'Standard Review Policy for Midstream' description: 'Applies standard AI review policy guidelines for midstream (implementation) phase reviews.' version: 0.1.0 category: midstream phase: midstream applyTo: - 'src/**/*.ts' - 'src/**/*.js' - 'src/**/*.py' - 'src/**/*.go' - 'src/**/*.java' - 'src/**/*.rb' - 'lib/**/*' - 'app/**/*' inputContext: - diff - fullFile outputKind: - findings - summary - actions modelHint: balanced dependencies: - code_search tags: - policy - midstream - implementation - code-quality severity: 'info' --- ## Goal / 目的 - 実装フェーズの差分に対して、バグ・安全性・保守性のリスクを短く指摘する。 ## Non-goals / 扱わないこと - 差分にないコードや仕様を断定しない(推測は “可能性” として扱う)。 - 重要度の低い “nit” を濫発しない(本質的なリスクを優先する)。 - プロジェクトの前提が不明なまま大規模リファクタを押し付けない。 ## False-positive guards / 抑制条件 - 変更がコメント・フォーマットのみで、挙動変更が見当たらない場合は深入りしない。 - リスクが不確実で根拠が薄い場合は、断定ではなく質問として扱う。 ## Rule / ルール - 差分に紐づく指摘だけを出す(根拠は `<file>:<line>`)。 - 優先度は「壊れる/漏れる/回復できない」ものから(例: 入力検証不足、例外握りつぶし、認可漏れ、型安全性の破壊)。 - 可能なら “次の一手” を最小で添える(過剰な提案は避ける)。 ## Evidence / 根拠 - 指摘は必ず `<file>:<line>` で追える形にする。 - 差分外の推測に依存する場合は、その旨を明示する。 ## Output / 出力 - 各指摘を 1 行で出力する: `<file>:<line>: <message>` - `<message>` は日本語で簡潔に(目安: 200 文字以内)。 - PR の本文(説明)と PR コメント(レビューコメント)は日本語で書く。 - 最大 8 件。指摘がなければ `NO_ISSUES` のみ。 ## Heuristics / 判定の手がかり(例) - I/O・外部 API のエラー処理不足(タイムアウト、例外伝播、再試行の意図が不明) - 入力バリデーション不足(URL/ボディ/環境変数/外部レスポンスのノーチェック使用) - 例外の握りつぶし(ログ無し、戻り値で隠蔽、cause が失われる) - 競合・リソースリーク(接続/ファイルハンドルの close 忘れ、共有状態の競合) - ハードコード値の増加(環境差異で壊れる設定値) ## 評価指標(Evaluation) - 合格基準: 指摘が差分に紐づき、根拠と次アクションが説明されている。 - 不合格基準: 差分と無関係な指摘、根拠のない断定、抑制条件の無視。 ## 人間に返す条件(Human Handoff) - 仕様や意図が不明確で解釈が分かれる場合は質問として返す。 - 影響範囲が広い設計判断やトレードオフは人間レビューへ返す。 ## レビュー姿勢(Standard of Code Review) - 完璧なコードを求めず、「PR を入れることでコードベース全体の健全性が改善するか」を判断軸にする (`google/eng-practices` の "Improve the overall code health" 原則)。 - 完璧主義的な書き直し要求や、好みベースの reformat 要求はしない。 - nit / 好み相当の指摘は `severity: minor` 以下に留め、`major` / `critical` は実害ベースの指摘に限定する。詳しい対応表は [`docs/development/google-eng-practices-mapping.md`](../../../docs/development/google-eng-practices-mapping.md) を参照する。