メインコンテンツまでスキップ

レビュー項目

ファイルや見出しの存在と内容の正しさは別です。自動検証の結果を確認したうえで、次の内容を人間が確認します。

説明の中心部分​

  • 何のパターンかを最初に理解できるか。
  • 全体構造から各設定・処理へ説明がつながるか。
  • コードが実ファイルと一致し、親キーやファイル名から対象箇所を特定できるか。
  • 設定値や構造の意味を説明しているか。項目名の言い換えだけになっていないか。
  • 具体的な入力・処理・結果が分かるか。
  • 他の部分との関係と、その値・構造を採用する理由が分かるか。
  • 画像は本文と一致し、読める大きさで理解を助けているか。

見出しの固定文言や文章量で判定しません。不足があれば対象の記述と必要な説明を特定して直します。

注意点が必要になる条件​

条件必要な説明
OS・実行環境・バージョンで動作が違う条件、動作の違い、対応方法
入力やデータに制限がある扱えない値・形式・件数、そのときの動作
通常どおりに動かない条件がある発生条件、結果、回避方法
既存ファイルや機能に影響する上書き・競合・削除などの影響と事前確認
利用先に合わせた変更が必要変更箇所、理由、設定例
検証できていない条件がある未確認範囲と確認済み範囲の境界

該当するものだけ説明します。不要なら節を省略し、意味のない注意事項を作りません。設定の近くに書く方が分かりやすければ、その説明に含めます。

実装と検証​

  • READMEだけで環境、依存関係、導入先、実行場所、使用・検証方法が分かるか。
  • ZIP内のファイルだけで利用でき、サイト側の依存関係や他のファイルを暗黙に使っていないか。
  • リポジトリ内の移行では、不要になった移行元が片付いているか。内容とZIP単体の動作を確認し、固有の記録を作業ツリー外へ保全しているか。コピー依頼や保持指定がある場合はその指定に従っているか。
  • ルートのscripts/がプロジェクト全体の共通処理に限られ、個別パターン専用処理は対象パターン内にあるか。既存コマンドで代替できるスクリプトを増やしていないか。
  • ルートのtests/が共通機能のテストとその補助処理・fixtureに限られ、個別パターン専用のテストは対象パターン内にあるか。
  • トップページの紹介が文書のメタデータから生成され、文書・ZIPへのリンクが対応しているか。紹介の追加のためにページのTSXやパス規則を複製していないか。
  • 個別検証がそのパターンの目的を確かめているか。
  • ci.jsonが必要な環境とコマンドを指定し、ZIP展開先だけで準備・検証できるか。個別手順が共通CIへ混ざっていないか。
  • CIの変更判定がPR全体の差分を使い、変更なし・改名・削除・共通処理変更を正しく扱うか。比較失敗を対象0件と扱わず、0件の場合もサイト検証に成功してから公開できるか。
  • setupを提供する場合、重要度と分類理由が台帳にあり、質問範囲を選べるか。省略した項目の維持と個別回答を区別し、範囲外の未確認の変更を検出できるか。
  • 違反検出の設定では正常例に加え、代表的な違反例を検出できるか。
  • 確認日・環境・期待結果・実際の結果があり、未確認を成功と扱っていないか。

最終報告では実装済み、自動検証済み、人間の確認済み、未確認を区別します。ビルド成功だけで個別実装や人間のレビューまで完了したと扱いません。