コーディングエージェントで作成したコードのレビュー基準:変更種別ごとの優先度
この記事で学べること
- コーディングエージェントで作成したコードを外部接続・データ変更・計算・表示へ分ける理由
- 変更種別ごとの確認優先度と、人が最初に見るべきリスク
- 差分、実行結果、影響範囲を順に確認するレビュー手順
コーディングエージェントで作成したコードは変更の影響と取り消しにくさでレビューの深さを決める
コーディングエージェントは、指示に沿ってコードの作成や変更を進めるAIです。そのコードを確認するときは、変更が外部へ及ぶか、実行後に取り消せるかに応じて、レビューの深さを変えます。
このサイトで変更を確認した際、すべてを同じ深さで読むと、外部接続やデータ更新など優先すべき項目が埋もれました。そこで、外部接続、データ変更、計算・変換、表示・デザインに分け、何を先に、どう確認するかを整理しました。以下は、その経験からまとめたレビュー基準です。
変更の影響に合わせてコードレビューを深くする
確認するコードが増えるほど、すべてを同じ方法で読むのは難しくなります。認証情報やデータの書き換えはコードの内容を確認し、計算は値を入れて試し、表示は画面で確かめるというように、対象に合う方法を選びます。
この優先度は、私の作業経験に基づくものです。プロジェクトの内容や、変更によって起きる問題に合わせて調整が必要です。
コードの種類と確認の優先度
優先度:高 外部サービスとの接続設定
APIキー(外部サービスを利用する際に、利用者を識別するための文字列)や認証情報、接続先の設定が含まれるコードは、実行前に確認します。
私は、APIキーの保存場所と、利用者を確認する認証の設定を見ます。実際に、設定ファイルへ直接書かれたAPIキーがGit(ファイルの変更履歴を記録するツール)の管理対象に含まれたことがありました。コードの構造だけを見ても、こうした情報の扱いは確認できません。
外部サービスに影響があり、問題が起きると対処に時間がかかるため、最初に確認する対象にしています。
優先度:高 データを変更・削除するロジック
データベースの更新、ファイルの上書き、記録の削除を行う処理は、実行前にコードを確認します。
特定のユーザーだけに適用するはずの処理が全員に及んでいないか、削除前に確認する手順があるかを見ます。実行後に戻すのが難しい操作では、対象を決める条件の確認を優先します。
優先度:中 計算・変換の処理
数値の計算、データ形式の変換、集計処理は、サンプルの値を入れて結果を確かめます。
通常の値に加えて、ゼロ、空、最大値など、処理の切り替わりで問題が出やすい値(境界値)も確認します。すべての組み合わせを試すのは難しいため、代表的なケースと例外ケースを数件選びます。
優先度:低 表示・デザインのコード
レイアウトやスタイルなど、見た目に関するコードは、ページを表示して意図どおりかを確かめます。この種類の変更では、コードの細部を読むより、表示結果を見ることを基本にしています。
コーディングエージェントで作成したコードは変更の影響に合う方法で確認する
変更前後の違い(差分)を見て、どの種類の変更が含まれているかを確認します。その上で、種類に合う方法を選びます。
- 外部接続:APIキーや認証情報の保存場所と、公開される範囲を確認する
- データ変更:処理の対象を決める条件が、意図した範囲に収まっているかをコードで確認する
- 計算・変換:代表的な値や例外となる値を入れ、実行結果を確認する
- 表示・デザイン:ブラウザで画面を開き、表示結果を確認する
確認後は、変更した箇所以外にも影響が及んでいないかを見ます。優先度の分類と、実際に影響した範囲の確認を合わせてレビューします。
まとめ:外部影響と取り消しにくさに合わせてレビューを深くする
レビューにかける時間は、外部へ影響する変更や、取り消しにくい変更へ優先して使います。分類した上で、コードを読む必要があるのか、値を入れて試すのか、画面で確かめるのかを選ぶのが、私の作業では判断しやすい方法でした。
この優先度を、医療、金融、安全制御などの領域へそのまま当てはめることはできません。表示の変更でも重大な影響があり得る場合は、その影響に応じた確認が必要です。