GitHubのプルリクエストでコードレビューをする際、デフォルトでは英語でレビューが行われます。これを日本語で行う方法について調べていると、GitHub Copilotのカスタムインストラクション設定を利用する方法があることがわかりました。
Customizing Copilot's reviews with custom instructions
しかし、実際に試してみるとうまくいきませんでした。以下に試行錯誤の過程と解決方法をまとめます。
前提
- GitHub Copilotが利用できる環境であること
- GitやGitHubの基本的な操作ができること
試行錯誤
最初は開発中のブランチに copilot-instructions.md を追加しました。
そしてコードレビューのコメントを日本語化するために、以下のカスタムインストラクションを設定しました。
# コードレビューガイドライン 日本語でレビューしてください。
しかし、変更をコミットしてプルリクエストを作成してGitHub Copilotのレビューをしても、レビューコメントは英語で返ってきました。
解決方法
色々試している途中、「GitHub Actionsはデフォルトブランチに定義しているワークフローが利用できる」というのを思い出して、同様にGitHub Copilotのカスタムインストラクションもデフォルトブランチにあるものが参照されるのではないかと考えました。
そこで、デフォルトブランチに移動し、同じ内容の copilot-instructions.md を追加しました。
# コードレビューガイドライン 日本語でレビューしてください。
その後、再度プルリクエストを作成し、GitHub Copilotにレビューを依頼したところ、無事に日本語でレビューコメントが返ってきました。
おわりに
無事に日本語でのコードレビューが行われるようになりました。また、使用言語だけでなく、コメントの話し方などもカスタマイズできるため、プロジェクトのニーズに合わせたレビューが可能です。
1つ気になっているのが、 copilot-instructions.md に記載する内容が増加してもそれらを考慮してくれるのかということです。それはまた別の機会に調査してみようと思います。
是非、皆さんも試してみてください。
