jww-repository-validation

リポジトリの検証

これは、ほかに検証方法が指定されていない場合に、変更を検証する方法を判断するための汎用的な代替指針です。リポジトリの指示や、文書化された検証コマンドがある場合は、これらの既定の指針より優先してください。

相応の検証とは、チェックの範囲とコストを変更の影響範囲に合わせることです。変更された成果物と動作を網羅できる、最小限の十分なチェックを実行し、変更の影響が広がるにつれて、統合テストやエンドツーエンドテストへと範囲を広げてください。

チェック内容を確認する

1. コマンドを選ぶ前に、適用される AGENTS.md、README、コントリビューター向けガイダンス、周辺の自動化設定を確認してください。
2. 変更されたファイルの種類と、.editorconfig、パッケージマニフェスト、CI ワークフロー、タスクランナー、フォーマッターやリンターの設定など、利用可能な構成を確認してください。
3. 新たにチェック方法を考案するより、既存の文書化されたチェックを優先してください。

相応の検証を選ぶ

• ドキュメント：読みやすさを確認し、git diff --check を実行してください。リポジトリで Markdown チェックが使用されている場合は、それも実行してください。
• ソースコード：編集が許可されている場合は、変更したファイルのみをフォーマットしてください。変更を検証する、範囲を絞ったテスト、静的解析、またはビルドを実行してください。読み取り専用のレビューでは、ファイルを変更せずにフォーマットの差異を報告してください。
• 構成、テンプレート、スクリプト：対象の成果物をレンダリング、解析、またはドライランし、該当する場合は構文チェックを実行してください。
• 広範囲またはリスクの高い変更：利用可能であれば、関連する統合テストまたはエンドツーエンドテストを追加してください。

まず、読み取り専用のチェックから始めてください。タスクの作成者がそのような操作を許可していない限り、検証だけを目的に依存関係をインストールしたり、構成を適用したり、データを移行したり、成果物を公開したり、そのほか外部の状態を変更したりしないでください。

必要かつ関連するチェックに合格したら、完了に進んでください。さらに変更があった場合、失敗した場合、または懸念が未解決の場合に限り、検証の範囲を広げるか、再度実施してください。

結果を報告する

1. 失敗を回帰と判断する前に、変更された動作に照らして確認してください。
2. 各コマンドまたは名前付きチェックを正確に報告し、結果を「合格」「変更に関連する失敗」「既存の失敗」「環境上の阻害要因」「スキップ」に分類してください。
3. チェックをスキップした場合は、利用できなかった理由、または実施が相応でなかった理由を記載し、残るリスクを示してください。