【GitHub Copilot】VS CodeでGitHub Copilotが生成するコミットメッセージを日本語にする方法

VS CodeでGitHub Copilotが生成するコミットメッセージを日本語にする方法

VS Codeのソース管理機能にある「コミットメッセージの自動生成(キラキラマーク)」。ボタン一つで変更内容を要約してくれて非常に便利ですが、デフォルトのままだと英語で出力されてしまうことがあります。

今回は、GitHub Copilotが生成するコミットメッセージを、常に綺麗な日本語かつ指定の文字数ルールで出力させるための設定手順を解説します。

前提条件

本設定を行うには、以下の環境が整っている必要があります。

  • VS Code(Visual Studio Code)がインストールされていること
  • 拡張機能「GitHub Copilot」および「GitHub Copilot Chat」がインストールされ、有効化されていること
  • GitHub Copilotの有料プラン契約、または有効なライセンス(インビテーション)があること

設定手順

1. settings.json(設定ファイル)を開く

VS Codeの基本設定をテキストで編集するため、settings.jsonを開きます。

  1. VS Codeを開き、コマンドパレットを表示します(Mac: Cmd + Shift + P / Windows: Ctrl + Shift + P)。
  2. 入力欄に「基本設定: ユーザー設定 (JSON)を開き」(英語環境では「Preferences: Open User Settings (JSON)」)と入力し、選択します。

2. 設定コードを追加する

開いたsettings.jsonの波括弧{ ... }の中に、以下のコードを追記します。

"github.copilot.chat.commitMessageGeneration.instructions": [
  {
    "text": "Commit messages must be written in Japanese. (必ず日本語で出力してください)"
  },
  {
    "text": "コミットメッセージは、変更内容を理解するのに十分な情報を提供する必要がありますが、あまり長くなりすぎないように簡潔に記述してください。"
  },
  {
    "text": "1行目は72文字以内に収めてください。"
  }
]

すでに他の設定が記述されている場合は、末尾にカンマ(,)を入れてから上記のコードを追加してください。

【Point】なぜ英語で「日本語にして」と書くの?
GitHub Copilotのベースは英語で構築されているため、一番最初の指示は英語で「Commit messages must be written in Japanese.」と明確に伝えた方が、より確実に日本語で出力してくれるようになります。

3. VS Codeを再読み込みする

設定を確実に反映させるため、VS Codeのウィンドウを再読み込み(リロード)します。

  1. 再びコマンドパレットを開きます(Mac: Cmd + Shift + P / Windows: Ctrl + Shift + P)。
  2. 開発者: ウィンドウの再読み込み」(英語環境では「Developer: Reload Window」)と入力して実行します。

動作確認

再起動後、ソース管理パネルを開き、コミットメッセージ入力欄の右側にある「✨(コミットメッセージの生成)」ボタンを押してみてください。変更内容が72文字以内の簡潔な日本語で生成されれば成功です!

よくある質問

設定を追加したのに英語のまま生成されます
VS Codeの再読み込み(Reload Window)を行っていない可能性、またはsettings.jsonの記述にカンマ抜けなどの構文エラーがある可能性があります。記述を確認し、エディタを一度再起動してみてください。
文字数のルールや「プレフィックス(feat:等)」の指定を追加したいです
"instructions"の配列の中に、{"text": "指示内容"} を追加していけば自由にカスタマイズ可能です。例えば、{"text": "Use conventional commits format."} と追加すれば、ルールに則った形式で出力してくれます。

CONTACT

webサイト制作、デザインに関するご相談、御見積のご依頼など、弊社へのお問い合わせはこちら