はじめに

いままで、GitHub Copilot に依頼するレビューは、「GitHub 上で PR （プルリクエスト）を出すときに、レビュアーに copilot もアサインすることで、差分をレビューしてくれる」という仕組みを利用していました。

まずは Draft 状態で GitHub Copilot にレビューしてもらい、一通り修正し終わったら Draft を解除し、これをもって人のレビューが Ready な状態としていました。

ただ、PR を出す前に typo ミスやコピペミスなどの凡ミスは潰しておきたいという気持ちが芽生えました。なんならコミット前に修正したいものです。fix typos のようなコミットメッセージも減らしたいですし。

こんなことを思っていたところ、手元の VS Code（GitHub Codespacesでも）上でも差分レビューができることに気が付きました。（結構前からあった機能かもしれません）

簡単ですが、試したときの方法をご紹介します。

VS Code 上での差分レビュー方法

あくまで「差分レビュー」なので差分が git 管理上の差分が必要です。具体的には、変更はしたけどまだコミットしていない差分が対象です。

以下は、git 管理上の差分がなく、レビューボタンがない状態です。

まず、レビュー対象とする何かしらの修正します。すると VS Code 上の Git 操作の画面に「コードレビュー」のボタンが表示されるので、このボタンを押します。

しばらくすると、レビューコメントが表示されます。今回は Ansible Playbook で Play レベルの become: true という指定についてコメントが付きました。インラインで表示されるのも便利ですね。

コメントはインラインだけでなく「コメント」パネルにも表示されます。

なお、レビューコメントに方言が入っているのは、.github/copilot-instructions.md に「レビューコメントは京都弁で書くこと」と指示しているためです。違う指示をするとにコメントが変わったので、ちゃんとこのファイルを読み込んでカスタムできていることも確認できました。

今回の VS Code 上での差分レビューは、差分に着目してレビューするときに有用そうです。

かといって、PR 出したときの GitHub Copilot のレビューは無くさない方が良いかなと思いました。開発者がうっかり VS Code 上の差分レビューをし忘れることを見越してのことです。

また、私は普段 git commit、git add、git push あたりの基本的な正常系の操作は、VS Code 上の GUI を利用することが多いです。なので、GUI による git 操作時にレビューボタンが目に入って来やすいのは私には合っています。

リモートリポジトリに GitHub を使っていなくてもできるレビューという点もありますね。実は今回のおためしもリモートリポジトリは GitLab です。

これまでも、チャットでもレビューの依頼ができていました。

ただ、チャットで普通に依頼すると差分ではなく全体的なチェックになります。プロンプトを入力するのもやや手間に思っていました。差分レビューを手間なくチャットで行うための、カスタムプロンプトなどの工夫の余地はありそうですが、工夫なく差分レビューできる今回の方法はラクに感じました。

全体的にチェックしてほしいときは、今回紹介している差分レビューではなく不向きかもしれないので、使い分けが必要ですね。

凡ミスは早めに修正したい私にとってはとても合っている方法だと感じたので、積極的に使っていこうと思います。

なお、差分レビューを自分の VS Code 上で行うか、PR を出したときに行うか、の比較については、レビュータイミング以外にもいつくか観点があるかもしれません。たとえば、GitHub リポジトリ側と自分の GitHub Copilot のプランの違いの都合など。

にしても、便利な時代になったものです。