本文へスキップ
表示言語: 日本語
監査 / Signal

AIによるコードレビューには、実際に読んだ版の明示が必要です

比較した版、実際に読んだファイル、修正後の確認をAIコードレビューの結果に結び付けます。

記事の言語: 日本語

大理石の上に置かれた、濃い色のリボンと封印で束ねた紙と、そのそばのペン。
目次

「変更をレビューしました。小さな指摘が二つありますが、それ以外に懸念はありません」。一つ厄介な問いがなければ、この報告で話を終えられるかもしれません。どの変更でしょうか。レビュー中に作成者は検証処理を追加し、設定ファイルを差し替え、指摘の一つを修正しました。アシスタントは読み終えましたが、コードは変わり続けていました。

これは架空の例です。ここで考えるのは特定のリポジトリの評価ではなく、レビュー範囲を示す証拠です。この文章でのコードレビューとは、問題を探すために変更とその前後関係を読むことを指します。テストの実行やデプロイへの同意とは異なります。「誤りは見つかりませんでした」という言葉は、どこで、どの版を調べたかと一緒に示されて初めて意味を持ちます。

会社はAeneia Auditに、AIの利用方法とその仕事を受け入れるための証拠の検討を依頼できます。コード自体の正しさや安全性を専門的に評価するには、適切な知識と別途定めた範囲が必要です。ここでは、レビュー担当者が受け取った資料と、意思決定する人に渡された結論との関係を整理します。

一つの依頼番号に複数の異なる変更が含まれる

あるスタジオが機材予約ポータルを拡張するとします。修正の目的は、利用を終了した機器を新規予約から除外しつつ、履歴には残すことです。機器の選択、空き状況の確認、予約の保存、設定、テストの五つのファイルを変更します。過去の予約では、新しいお客さまにはもう提供できない機器も引き続き識別できなければなりません。その違いが読む際の焦点です。

プルリクエストはコード変更の提案であり、一日中同じ番号のままでいることがあります。しかし中には、保存された版が次々に追加されます。そのため依頼の識別子は、実際に読んだバイトを正確に示す印ではありません。報告には、開始状態と評価した提案状態という比較の基準点が必要です。

デルタとは、二つの状態の差分です。始点を定めなければ、「変更をレビューした」は最後の修正、作業開始からの全体、まだ保存された版に含まれていないローカルファイルのどれを指すかもしれません。どの範囲にも理由はあり得ます。ただし、ツールの初期設定によって偶然一つが選ばれてはいけません。

git diffの文書は、作業ファイルとステージング領域の比較、ステージング領域と一つの版の比較、保存済みの二つの状態の比較を区別しています。したがって「diff」という言葉だけでは、評価した資料の組み合わせは分かりません。

ポータルの例では、修正前を状態A、五つの変更ファイルを含む状態をBと仮に定めます。レビュー担当者にはAとBの差分と必要な文脈を渡す必要があります。これらの文字は本文中の呼び名であり、実際の版の識別子ではありません。実際の報告では、評価した資料を探し出せる正確な情報に置き換えます。

ローカルファイルで作業する場合、保存済みのリポジトリ識別子に現在の修正が含まれていないことがあります。その場合は保存したコピーなど、評価対象の状態を固定する合意済みの方法が必要です。読み終えた後で新しい識別子を書き加えても、以前のレビューが新しいファイルを対象にしたことにはなりません。

データから計算した要約値であるAI報告書のハッシュ (ポーランド語)(リンク先はポーランド語です。)は、特定の資料を識別する助けになります。ハッシュだけでは資料を読んだことも、結論が正しいことも証明できません。版の表示には、実際に読んだ範囲を添える必要があります。報告書の隣同士の欄に入っていても、証拠の別々の部分です。

ブランチを更新した後も比較の始点を残してください。ベースが変わると、同じ最終ファイルでも異なる方法で定められた差分に属することがあります。次の読み直しがBからCへの修正なのか、新しい始点に対する提案全体なのかを報告書に説明します。そうしなければ、以前見えていた二つのファイルが突然一覧から消えた理由を読み手は理解できません。

版は読む間安定しているか、後から再現できる必要があります。作成者が作業を続けているなら、現在の提案がCへ進む間、レビュー担当者は保存したBのコピーを読めます。並行作業として合理的です。ただし、その報告を後からCのレビューと説明してはいけません。

五つの名前の一覧は五つのファイルを読んだ証拠ではない

架空の報告で、アシスタントは変更一覧から五つのファイル名を挙げています。しかし具体的な指摘は機器の選択と空き状況だけに関するものです。残り三つは読んだのでしょうか。重要でないとして省いたのでしょうか。それとも内容そのものを受け取っていないのでしょうか。名前の一覧だけでは答えは分かりません。内容を読んだ結果ではなく、索引から来た一覧かもしれません。

資料ごとに簡潔な範囲の説明を求めましょう。例えば、呼び出し元の関数と一緒に差分を読んだ、ファイル全体を読んだ、生成ファイルを省いた、内容を取得できなかった、ツールの応答が途中で切れた、といった状態です。それぞれ意味が異なります。一つの小さな修正を評価するために、周囲のすべてを読んだと主張する必要はありません。

このポータルでは設定ファイルが、どの機器カテゴリを表示するかを決めます。アシスタントがそのファイルを受け取っていなければ、利用終了した機器の完全な除外を確認したと主張すべきではありません。それでも空き状況を調べる関数について有効な指摘はできます。結論の広さは、作業の題名ではなく、実際に調べた依存関係に合わせるべきです。

GitHubではファイルをViewedと記録でき、後でファイルが変わるとその印が外れます。これは画面上で進行状況を追跡する仕組みです。モデルの分析の深さやレビューの完全性を独立に証明するものではありません。

ツールが大きなファイルの一部しか表示しなかったなら、その事実を報告書に残してください。コマンドを呼び出したというだけで「ファイルを読んだ」と書き換えてはいけません。応答が出力上限で止まった可能性があります。AIの長いコンテキスト (ポーランド語)(リンク先はポーランド語です。)でも、内容を渡すことと正しく利用することは異なります。レビューでは、まず少なくとも前者を確かめる必要があります。

Aeneiaのコンセプト写真

変更された行の外にある文脈も重要ですが、問いに合わせて選びます。機器を確認する新しい条件を評価するために、その関数を呼ぶ場所を見る必要があるかもしれません。引数名の変更なら呼び出し箇所の確認が必要です。だからといって、最初のライセンスファイルから最後のアイコンまでリポジトリ全体を必ず読むという意味ではありません。

記録では補助的な文脈と評価対象の変更を分けられます。レビュー担当者がプロジェクトの指示を開いたなら、どの版の規則を考慮したかを書きます。外部依存のコードを調べていないなら、関数がそれを使っているというだけで対象範囲に含めてはいけません。境界を明確にすると、次の人がまだ証拠のない場所に注意を向けられます。

自動生成された要約やプレビューは特に慎重に扱ってください。依存関係の変更プレビューでは元ファイルのすべての変更を表示しない場合があります。画像やバイナリファイルも、ツールが新しいサイズを記録しただけでは内容を評価したことになりません。報告書には、別の方法で確認する資料として正直に示せます。

Aeneia Audit: 自動レビューの証拠を整理しましょう。資料の版、実際に読んだ範囲、修正後の受け入れが対象です。チームは以前のパッチへの指摘と現在の提案の評価を区別できます。AIレビューの報告を特定の変更に結び付ける。

指摘を直すと次の評価対象が生まれる

アシスタントは、利用終了した機器を直接URLからまだ選べると気付きます。作成者は予約の保存処理を修正します。同時に関数の引数を整理し、テストを変え、設定に新しいカテゴリを追加します。状態Cが生まれました。指摘された問題を取り除いたことだけでは、残りの変更が正しい証拠にはなりません。

そのため再受け入れでは二つの問いがあります。Bで見つかった具体的な問題は取り除かれたか。BとCの間に何が新しく加わったか。前者だけに絞ると修正中に入った不具合を見落とすかもしれません。逆に以前の指摘を把握せずAからCの全体をレビューすると、特に確認すべきだった点を見失うことがあります。

GitHubのAPIによるレビュー作成の説明では、評価対象のコミット、つまり保存されたコード状態の識別子を指定できます。文書は、指定した行が後の変更で変わるとコメントが古いものとして表示される場合があると警告しています。指摘の位置は資料の版と結び付いています。

したがって、行番号が移動したことを問題の解決とみなしてはいけません。画面でコメントが古くなっていても、誤りが別の場所に残っていることがあります。逆に、作成者が関連する関数を修正してもコメントが見え続けることがあります。受け入れ担当者はスレッドの見た目だけでなく、指摘の内容と現在の動作を確認する必要があります。

読み直しの結果は、例えば「三つのファイルでBからCへの差分を確認し、空き状況を調べる関数の呼び出しも読み直した。残り二つはBのコピーと一致する」と書けます。これは報告の形式の例です。作成者が「そこはもう触っていない」と保証しただけでなく、実際に比較した後にのみ使えます。

ただし、変更されていないことは以前の不足を消しません。Bの設定を読んでいなかったなら、「Bから変更なし」という情報も設定をレビューした証拠にはなりません。その範囲を補うか、未解決の限界として残す必要があります。この例では設定にカテゴリを追加する際、新しい一行だけを依存関係なしに読むのではなく、以前の規則も把握する必要があります。

Copilot code reviewの案内は、適切な設定がなければ新しいpushによって自動的な再レビューは始まらないと説明しています。手動で再レビューを依頼するか、新しいpushのレビューを有効にできます。次のコミットが現れただけで、新しいレビューが行われたことにはなりません。

自動処理では、完了した実行がどの版を対象にしたか残してください。処理がBについて開始し、Cが公開された後に終了しても、Bの結果を正しく報告することはできます。二つの出来事が同じ依頼で起きたというだけで、要約がその評価を現在の版に付けると問題が生じます。

レビューがプルリクエストのCI処理 (ポーランド語)(リンク先はポーランド語です。)で動くなら、どの指示と内容を使うかも別に定めます。CIはリポジトリの変更によって起動される自動処理です。読んだ範囲の証拠だけでは、環境のアクセス境界が適切だったかは分かりません。ツールが一つの結果を表示しても、読む範囲と環境へのアクセスには別々の答えが必要です。

ファイル名が変わった後も、以前の範囲とのつながりを残してください。古いパスが消えても、その動作が取り除かれたとは限りません。コードが移動した可能性があります。レビュー担当者は修正が移った場所を探し、必要な呼び出しを確認します。「古い名前がないので問題は終了」とする報告では、新しいモジュールにある同じ不具合を見落としかねません。

この報告から何を受け入れられるか

報告書は、説明した範囲で問題を見つけなかったと正直に述べられます。誤りが存在しない証明ではありません。テストを実行したことも自動的には確認できません。AIと行ったテストの証拠 (ポーランド語)(リンク先はポーランド語です。)には、コマンド、条件、結果が含まれます。コードを読むことは別の作業です。最終判断では両方が互いを補えますが、互いの代わりを装うべきではありません。

すべての情報を「確認済み」という言葉に集める代わりに、境界を分けた短い結果を残してください。

  • レビュー対象の版と比較。
  • 実際に読んだファイルと必要な文脈。
  • 発見した問題と、その後の解決方法。
  • 省いた、または利用できなかった資料と、その制限が結論に与える影響。
  • テストが依頼範囲に含まれていた場合、その実行を示す別の証拠。

こうした記録は、提供者からコードと文書を受け入れるとき (ポーランド語)(リンク先はポーランド語です。)にも役立ちます。会社が実際に受け取る資料と評価を結び付けられるからです。ブランチ名、会議の日付、コメント数は状況の把握に役立つかもしれませんが、このつながりの代わりにはなりません。

判断する前に、現在の提案と最後に受け入れた範囲を比べます。機器カテゴリの設定が追加されたなら、それを読む対象に回し、以前の報告はBの評価として残してください。次の版が合意済みの修正だけを扱うなら、その修正と依存関係をどう確認したか説明します。変わっていないファイルすべてを、再び大規模にレビューする必要はありません。古い報告が未来を読んだかのように扱うのをやめる必要があります。

Aeneia / Aeneia編集部

編集部による記事です。本文中に出典へのリンクがあります。

Aeneiaについて

ご一緒したブランド

  • L’Oréal
  • Garnier
  • Netflix
  • Carrefour
  • Warner Bros. Discovery
  • Biedronka
  • HBO Max
  • Wolt
  • Żabka
  • COSRX
  • 在ポーランド中国大使館
  • Mixa
Aeneia / Initium

知識から決断へ

整理したい課題をお聞かせください。どこから始めるかを一緒に決めます。

Aeneiaに問い合わせる

パートナーのソリューションを活用しています

  • Google
  • OpenAI
  • Microsoft
  • Stripe
  • Anthropic
  • Linear