typememo.jp

git commit template – コミットメッセージテンプレート作成方法

2020.11.29

#tech#git#template
Takeru Yamada

Contents


はじめに

Git のコミットメッセージテンプレートを設定する方法について調べたことをまとめました.

テンプレ化が好きなので調べて面白かったです.

それでは参りましょう.

参考:


commit.template でコミットメッセージテンプレートを設定する

早速ですが,コミットメッセージテンプレートの設定コマンドはこちらです.

$ git config [--system | --global | --local] commit.template /path/to/.gitmessage.txt

事前に .gitmessage.txt にコミットメッセージのテンプレートを書いておきます. テンプレートを書いたら,後はテンプレートを有効にするだけです. 想像していたよりもとても簡単だと思います.

コミットメッセージテンプレートの使い所について,筆者が思い当たることを書いておきます.

各プロジェクトや各リポジトリでコミットメッセージのルールは異なりますよね? それぞれのコミットメッセージのフォーマットとか覚えられないですよね?

そんな時こそ commit.template の出番だと思います.

wiki などにコミットメッセージのルールなどを書くのはやめて, リポジトリ内に .gitmessage ファイルを定義して, コミットルールをリポジトリ内で管理する方が良いのではないでしょうか? リポジトリの README に

$ git config --local commit.template /path/to/.gitmessage

を実行してね, と書いておけば面倒なコミットルールの指摘コミュニケーションともおさらばすることができると思います.

他にも活用できる場面はあると思いますが,筆者が思い当たるところはこれくらいです.

おわりに

Git のコミットメッセージテンプレートの設定方法についてちょっとだけでも理解が深まれば幸いです.

この記事をきっかけにして一人でも多くの人がコミットメッセージテンプレートを使うようになれば, 筆者として至上の喜びです.

この記事以外にも読んで役に立つような記事を書いていますので, 記事についているタグからいろいろな記事へ飛んで読んでいただけるとありがたいです.

最後までお読みいただきありがとうございました.

応援していただけるととても嬉しいです!


愛用品


関連記事