💬

VS Code のコミットメッセージ自動生成が強化されました（with Copilot）

2024/12/13に公開

Git

はじめに

VS Codeにコミットメッセージ自動生成の機能が実装されてしばらく経ちますが
要望が多かった^[1]コミットメッセージの指示が出来るようになっています。

リリース当時の投稿

GitHub Copilot のアップデート

直近のリリース（12/12？）で、コミットメッセージ生成に対する設定項目が追加されています。

[Preferences] => [Settings]

github.copilot.chat.commitMessageGeneration.instructions

※ 他にも、コード生成やチャットに関する設定があります。

指定方法

A set of instructions that will be added to Copilot requests that generate commit messages. Instructions can come from:
・ a file in the workspace: { "file": "fileName" }
・ text in natural language: { "text": "Use conventional commit message format." }
Note: Keep your instructions short and precise. Poor instructions can degrade Copilot's quality and performance.

直接指示（text）を定義するか、外部ファイル（file）の参照の指定^[2]ができます。

    "github.copilot.chat.commitMessageGeneration.instructions": [
                { "text": "..." },
                { "file": "xxx.md" }
    ]

※ textとfileを同時指定でも反映されます
※ file 指定は、workspace内の相対パスで、絶対パスだと動作しなさそうです。

動作

極端な例ですが、デフォルト英語から日本語での生成、接頭辞、語尾が反映されていることを確認できます。

settings.json

+     "github.copilot.chat.commitMessageGeneration.instructions": [
+         { "text": "日本語で回答します。" },
+         { "text": "語尾に「ですわ」で回答します。" },
+         { "file": "commit-style.md" }
+     ]

commit-style.md

先頭に接頭辞(prefix)を付けて下さい。

さいごに

本日13日ではありますが、アドカレの9日枠が空いていましたので、参加させて頂きました。
カスタマイズが捗りそうですね。

脚注