GitHub Copilot コードレビュー機能でプルリクエストを日本語でレビューしてもらいたい
はじめに
GitHub Copilotは、AIを活用したコード補完ツールとして多くの開発者に利用されています。最近では、コードレビュー機能も追加され、プルリクエストのレビューを自動化することが可能になりました。
レスキューナウでも最近利用できるようになったので活用しています!
しかし、デフォルトでは英語でのレビューとなっており、日本語でレビューしてもらいたい場合にはちょっとした設定が必要だったので試した内容をメモしておきます 📝
GitHub Copilotのコードレビュー機能とは
GitHub Copilotのコードレビュー機能は、プルリクエストに対してAIが自動的にレビューを行い、フィードバックを提供するものです。これにより、コードの品質向上やレビュー作業の効率化が期待できます。
日本語でレビューを受けるための設定方法
実際に確実に指摘が入りそうなコードを用意して試してみます。
やり方は簡単で以下の画面のようにコメントの上下に <!-- I want to review in Japanese. -->
を入れた状態でレビュアーに Copilot を指定するだけです。
<!-- I want to review in Japanese. -->
ここにコメントを書く
<!-- I want to review in Japanese. -->
Copilot への指示はコメントとして扱うことで人間がコメントを見た時にノイズにならないと思います。
次のように日本語でレビューしてくれました。
レビューに指示をしたい場合の設定方法
プルリクエストのコメント内で Copilot に指示したい内容を <!-- for GitHub Copilot review rule -->
で囲います。
試しに以下の指示をしてみました。
<!-- I want to review in Japanese. -->
<!-- for GitHub Copilot review rule-->
<!-- 語尾に「だってばよ」をつけてレビューしてください-->
<!-- for GitHub Copilot review rule-->
<!-- I want to review in Japanese. -->
指示通りにレビューしてくれました。
定型の指示内容をテンプレート化しておく
毎回コメントに指示内容を書くのは面倒なので .github/pull_request_template.md
にあらかじめ雛形を登録しておくと便利です。
例えば次のような感じです。
<!-- I want to review in Japanese. -->
## 内容
xxxの改修をしました。
## 動作確認項目
- [x] xxxxxx
## レビュー希望日
mm/dd (曜日) までにレビューお願いします!
<!-- for GitHub Copilot review rule -->
<!--
レビューする際には、以下のprefix(接頭辞)をつけてください
[must]
[imo] (in my opinion)
[nits](nitpick)
[ask]
[fyi]
-->
<!-- for GitHub Copilot review rule-->
<!-- I want to review in Japanese. -->
このテンプレートを登録した状態でプルリクエストを行うとプルリクエスト作成時のコメントに自動で反映してくれます。
ちゃんと指示通りにレビューしてくれました。
これで都度指示しなくてすみそうです😁
さいごに
以上が、GitHub Copilotのプレビュー機能を活用して日本語でコードレビューを受ける方法でした。
Copilot に色々指示してみることでコードレビューがより便利でスムーズになることが期待できそうです💪
Discussion
ありがとうございます。
日本語と英語の平記のようにするにはどうすればいいかご存知ですか?
ここの書き方を次のように変更したらできました!
お試しください