注意
タイトルの通りなのですぐに手順紹介！
・・・と行きたいところですが、1つだけ注意点。
この記事で紹介する方法はGitHubのRulesetsという機能を使いますが、
これはGitHub Freeプランのプライベートリポジトリでは使用できません。
使用には有料のアカウント、Organizationリポジトリ、またはFreeプランのパブリックリポジトリである必要があります。
それでは見ていきましょう！
記事作成にあたって参考にした公式ドキュメント
Rulesetの作成
Rulesets作成ページに移動
-
リポジトリページ上部の「Settings」をクリック
-
左側のRules内の「Rulesets」をクリック
-
緑のNew rulesetボタンから「New branch ruleset」をクリック
-
Ruleset Nameには分かりやすい名前をつけましょう。そしてEnforcement statusはActiveにします。
-
このRulesetを適用したいブランチを選択します。基本的にはDefaultブランチでいいと思います。
-
Branch rulesの「Require a pull request before merging」にチェックをつけ、さらにその中の「Automatically request Copilot code review」にチェックをつけます。
-
最後にCreateボタンを押してルールセットの作成は完了です。
PRを作成してみる
この時点ではまだ日本語化はされていませんが、試しにPRを出してみます。
-
PRを作成すると右上のReviewersのSuggestionsにCopilotが現れます。Requestをクリックします。
-
少し待つと、Copilot君がレビューコメントを書いてくれました！
-
ご丁寧に修正すべき点を折りたたんでくれています。
レビューの日本語化
はい、ここまででCopilotにレビューを書かせることはできましたが、まだ肝心の日本語化ができていません。
ここからはその手順を2つ説明していきます。
1つ目 copilot-instructions.mdファイルを使う方法
-
.githubフォルダ内に
copilot-instructions.mdファイルを作成
-
マークダウン形式でCopilotが使用する言語を指定します。これをDefaultブランチにマージしておきます。
## 使用言語 日本語でレビューしてください。 -
再度PRを作成して、Copilotにレビューを依頼すると・・・
-
来ました！Copilot君が日本語でレビューを書いてくれるようになりました
2つ目 pull_request_template.mdを使う方法
-
.githubフォルダ内に
pull_request_template.mdファイルを作成
-
Copilot向けに「日本語でレビューしてくれ！」とメッセージを書いておきます。
<!-- for GitHub Copilot review rule --> <!-- PRのタイトルを修正すべきであれば指摘してください 日本語でレビューしてください --> <!-- for GitHub Copilot review rule--> ## 概要 <!-- issueがあれば以下に記載する --> <!-- close #xxx --> <!-- 関連するBacklogがあれば紐づける --> <!-- https://world-wing.backlog.com/projects/PSC --> ## 変更内容 <!-- - このプルリクで何をしたのか？ --> ### スクリーンショット <!-- 画面で見せれるものであれば必ずスクリーンショットを添付する --> -
レビューを依頼すると、ちゃんと日本語になりました！
最後に
copilot-instructions.mdファイルにはもっと色々設定を追加できるので
チームの好みやプロジェクトの目的に合うようにカスタマイズしてみてください！