【Git】コミットメッセージのテンプレートを設定する

目次

• コミットテンプレートとは
• テンプレートファイルの用意
• 使用例

コミットテンプレートとは

git のコミット時に自動で生成されるコメントを設定することができる機能です。プロジェクト内でコミットメッセージのフォーマットを統一したい場合に使用することがありました。

テンプレートファイルの用意

任意の場所にテンプレートファイルを用意し、git config でそのファイルをセットする

$ touch ~/.gitmessage.txt
$ git config --global commit.template ~/.gitmessage.txt

$ touch ~/.gitmessage.txt
$ git config --global commit.template ~/.gitmessage.txt

[ticket: #xxxx][Task/Bug] Subject line

what happened
ref : ticket link

使用例

$ git commit

[ticket: #xxxx][Task/Bug] Subject line

what happened
ref : ticket link

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
# On branch master
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
# modified:   hoge/test.txt
#