早くも新年度になり、桜が咲き始める季節になりましたね🌸
エイプリルフールネタを考えてみましたが、特に思い浮かびませんでした🤨
今回はGitHub CopilotのAIコードレビュー機能を使ったTipsを紹介します。
GitHub Copilotのコードレビューとは
GitHub Copilotのコードレビュー機能を使うと、プルリクエストのコードレビューをCopilotにお願いすることができます。
ちなみに、GitHub Copilot Enterprise のサブスクリプションに加入している組織ではコーディングガイドラインを別途設定できるようですが、以下の記事はEnterprise のサブスクリプションに加入していない組織のリポジトリでも使えるTipsです。
日本語でレビューさせる方法
デフォルトだと英語でレビューされてしまいますが、PULL_REQUEST_TEMPLATE.mdに以下のように設定することで日本語でレビューしてもらえます。
<!-- I want to review in Japanese. -->
## 要件
## テスト項目
- [x] xxxxxx
以下略
<!-- I want to review in Japanese. -->
日本語レビューして欲しい旨を先頭行と最終行で挟んであげると、Copilotが日本語でレビューしてくれます。
2025/3/7からこの設定を有効にしていますが、現在でも有用な設定です。
レビューについて指示を出す
同じく、PULL_REQUEST_TEMPLATE.mdでレビューについてのプロンプトを埋め込んでおくと
その指示通りにレビューしてくれます。
## レビューに関して
レビューする際には、以下のprefix(接頭辞)を付けましょう。
<!-- for GitHub Copilot review rule -->
[must] → かならず変更してね
[imo] → 自分の意見だとこうだけど修正必須ではないよ(in my opinion)
[nits] → ささいな指摘(nitpick)
[ask] → 質問
[fyi] → 参考情報
<!-- for GitHub Copilot review rule-->
## PRのルール
- まずはDraftでPRを作成する。
- レビューに出せる状態になったらOpenにする。（レビュワーがランダムにアサインされます）
- レビューなしでのmainブランチへのマージは原則禁止
以下、あえて誤った実装をしたらどうなるか実験してみました。
Copilotによるレビュー結果
きちんとプレフィックス[must]を書いてくれました。
ポイントは…
- プロンプトを
<!-- for GitHub Copilot review rule -->で挟む - 英語で指示をする(日本語で指示するよりも指示が通りやすい傾向にある)
- AI向けの指示はコメントアウトしておくことで、人間がコメントを見た時にノイズにならない。
チームごとに定められたコーディング規約をここに書いておくと良さそうですね。
別のドキュメントにコーディング規約が書いてある場合は、コメントアウトしておくことで
ノイズにならずに済みます（ただし規約が二重管理になるデメリットもある）
所感
今までCodeRabbitやPR-Agentなど、AIコードレビューツールの検証をしてきましたが、
後発のGitHub CopilotによるAIコードレビュー機能もなかなか優秀です。
追加料金無しで利用できるのは大変ありがたいですね。
コードレビューの規約をPULL_REQUEST_TEMPLATE.mdに埋め込んでおくことで
Copilotによるレビュー品質の向上とレビュワーの負担軽減ができると思います。
PULL_REQUEST_TEMPLATE.mdのサンプルを置いておくので参考にしてみてください✨️
Discussion