Alternative Architecture DOJO

オルターブースのクラウドネイティブ特化型ブログです。

【Visual Studio】GitHub Copilotでのコミットメッセージ生成がより使いやすくなった話

こんにちは!めゆです!

こちらの記事はオルターブースアドベントカレンダー23日目の記事になります。

ほかのアドベンター記事はこちら↓から

adventar.org

前提

今回使用しているVisual StudioとGItHub Copilotのバージョンは下記になります。また、GitHub Copilotを使用するにはGitHub Copilotライセンスの契約が必要となります。

  • Microsoft Visual Studio Enterprise 2022 (64 ビット) - Preview Version 17.13.0 Preview 1.0
  • GitHub Copilot 17.13.92.3300

Visual StudioでGitHub Copilotにコミットメッセージを書いてもらう

まず、Visual Studio上のGitHub Copilotは差分からコミットメッセージを生成することができます。 こちらの機能が出たときの弊社メンバー記事がありますので、よろしければ一緒にご覧ください。

aadojo.alterbooth.com

では早速コミットメッセージを生成してもらいます。
適当に差分を加えて、下記の鉛筆のようなマークを押すと、GitHub Copilotによるコミットメッセージの生成が可能です。

承諾して、編集をすることも可能となっています。

以前は英語のみのコミットメッセージ生成だったのが今では日本語で生成されるようになっています。便利ですね!

それでは、最近追加されたプレビュー版の機能である「コミットメッセージのカスタム」を行いたいと思います。

設定の仕方は以下の通りです。

Visual Studio右上の [GitHub Copilot] をクリックし、[設定] → [オプション] の順でクリックします。

すると、下記のような設定画面が開かれますので、こちらでコミットメッセージをカスタマイズしていきます。自然言語で入力します。

今回は下記のような入力をしてみました。

前提:コミットメッセージは全体で一行で表現したいです。

例:[modify] #129 単体テストを修正

上記の例のように、まずコミットメッセージの初めには、修正の内容を示すものを入れます。その種類には、単純な修正の場合modify、ファイルの追加はadd、ファイルの削除はdelete、をお願いします。

その次に現在のブランチで対応しているIssueの番号を#の後に書きます。ブランチ名と対応させているので、develop/issue〇〇の部分からIssue番号を抜き取ってください。番号がわからなかった場合は#のみつけておいてください。

その後、修正の内容を30文字以内で要約してください。

それでは先ほどと同じ差分でコミットメッセージを生成してみます。

残念ながらIssue番号は拾えなかったものの、いい感じに生成してくれました!あとは承諾してIssue番号をつけて、コミットができます。

まとめ

Visual StudioのGitHub Copilotを使うことで簡単にコミットメッセージを作成することができました!

あとはIssue番号をどこかで指定できるようになれば良いなと思います。
GitHub Copilotを使って素敵な開発体験を!


サービス一覧 www.alterbooth.com cloudpointer.tech www.alterbooth.com