Gitコミットメッセージを入力条件から生成する方法

入力内容から文面を整える

Gitのコミットメッセージを、タイプ、スコープ、メッセージ、破壊的変更の指定から整えて生成できます。入力したメッセージをそのまま使う方法に加え、メッセージ欄を空欄にして組み込みのテンプレートと語句から文面を作る方法も選べます。変更内容を確認したうえで、コミットに使う文面のたたき台を用意したいときに利用してください。各項目は必要に応じて入力でき、テキスト項目の初期値は空欄、破壊的変更の指定は無効です。

項目を選んで生成する

コミットのタイプを入力します。認識されたタイプを指定した場合はその値が使われ、空欄なら組み込みの候補からタイプが選ばれます。
スコープを必要に応じて入力してください。値を入れると出力の該当部分が括弧内に置かれ、空欄の場合は組み込みの候補からスコープが選ばれます。
メッセージ欄には変更内容を表す文面を入力します。入力した文面はメッセージ本文として使われます。自分で文面を決めない場合は空欄にすると、組み込みのテンプレートと語句から文章が作られます。
破壊的変更に当たると判断した場合だけ、その指定を有効にします。
生成を実行し、タイプ、スコープ、本文が変更内容と合っているか確認します。空欄の項目から選ばれた内容が意図と異なるときは、値を入力してから再生成してください。

生成後に確認する部分

基本の出力には、選ばれたタイプ、必要に応じた括弧付きスコープ、生成されたメッセージが含まれます。破壊的変更の指定を有効にした場合は、生成文の後ろに空行と破壊的変更の通知が加わります。さらに、空行の後へ固定の箇条書き3行が追加されるため、本文だけを想定している場合は後半も確認してください。メッセージ欄を空欄にした結果は組み込みの選択に左右されるので、採用前に変更内容との整合性を読み直します。処理に失敗したときは失敗として扱われ、例外の内容が表示されます。

使用例

決済画面の表示を変更したため、文面は自分で指定し、タイプとスコープは候補から選ばせる場面です。

タイプ欄とスコープ欄を空欄にし、メッセージ欄へ「決済画面の表示を更新」と入力して、破壊的変更の指定を無効のまま生成します。

出力には組み込み候補から選ばれたタイプとスコープ、入力したメッセージが含まれ、空行の後に固定の箇条書き3行が続きます。破壊的変更の指定は無効なので、その通知は追加されません。

制限事項

確認できるのは入力から生成されたコミットメッセージです。実際に使う前に、表示された文面を変更内容と照合してください。

よくある間違い

タイプやスコープを空欄にした結果を確認せず採用すると、組み込みの候補が変更内容に合わない場合があります。生成後に両方の値を見直し、必要なら具体的な入力へ差し替えて再度生成してください。

よくある質問

メッセージ欄を空欄にするとどうなりますか？

メッセージ欄に文面が入っていれば、その入力が本文に使われます。何も入力しない場合は、組み込みのテンプレートと語句を組み合わせてメッセージが作られます。

コミットのタイプは指定できますか？

認識されたタイプを入力した場合は、そのタイプが出力に反映されます。値を指定しなければ、組み込みの候補からタイプが選択されます。

破壊的変更の通知を加えられますか？

指定を有効にした場合、生成された文面の後ろに空行と破壊的変更の通知が追加されます。指定を有効にしない場合は、その通知を追加する条件にはなりません。