GitHub Copilot のコミットメッセージ生成のルールがカスタムできるようになった！

追記

2025/03/24 - 実験中という記述がなくなったため、正式提供されたと思われます。内容を少し修正しました。

はじめに

VSCodeの拡張機能 GitHub Copilot はとても便利ですよね。その Copilot の機能の一つとして コミットメッセージの自動生成 機能があります。

ただこちらの生成機能、そのままだと簡潔すぎたり、高確率で英語で生成されるため、少し不便に感じることもあります。

(できれば日本語でできればもっと詳細に書いてほしい、、、）

そんな中、最新版のVSCode（ 1.96以降 ）ではコミットメッセージにカスタム指示を設定できるようになりました！

Custom instructions for commit message generation

この便利な機能をぜひみなさんに知ってほしくて記事を書きました。設定もとても簡単です👺

設定方法

今回はユーザー環境（ローカル）での設定方法を説明します。

大前提としてVSCodeは v1.96 以上にアップデートをしてください

公式ドキュメント: Define commit message generation custom instructions

まずは setting.json を開きます。スクショの ユーザー設定を開く ですね

開いたら以下のように設定を追加します。

{
  ...
  "github.copilot.chat.commitMessageGeneration.instructions": [
    {
      "text": "..." // こう書いてほしいというルールを記述します。文は一文で簡潔に書くのが良いそうです
    },
    {
      "text": "..." // 一文に収まらない場合はオブジェクトを追加することができます。
    },
    {
      "file": "./commitMessageRule.md" // ルールを外部ファイルに記述することもできます
    }
  ]
}

例えば僕の環境で以下のように設定しました

{
  ...
  "github.copilot.chat.commitMessageGeneration.instructions": [
    {
      "text": "必ず日本語で記述してください"
    },
    {
      "text": "コミットメッセージは、最初にConventional Commitsに則って記述してください"
    },
    {
      "text": "その後ファイルごとの詳細な変更内容を記述してください"
    }
  ]
}

これにより、生成されたコミットメッセージは以下のようになりました。

わかりやすい！いい感じです👍

ルールは外部ファイルにも記述できます。ワークスペース機能と組み合わせて、チームやプロジェクトごとにコミット生成のルールをより柔軟に管理することができそうです。

補足

• あくまでAIの自動生成なので、本当に内容があっているかどうかはチェックしてくださいね
• よりよいカスタムルールがあれば教えてください！

まとめ

VSCodeのCopilot機能はアップデートのたびに進化しています。VSCode自体は毎月アップデートされているので、興味があれば月に一度、リリースノートをチェックしてみてください。

公式サイト: https://code.visualstudio.com/updates