eyecatch thumbnail

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

Profile picture
ルッチ / Lucci
2020.11.29

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

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

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

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

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


愛用品


関連記事


大学生へのお知らせ

ここまで記事を読んでくれて本当に嬉しいです、ありがとうございます。

プログラミングを始めたばかりの頃って「やるぞ!」という気持ちは強めですが、 実際に取り組み始めると「何からどうやってどこまでやればいんだ?」 という感じで羅針盤を失うことが多いような気がします。(実体験)

そんな勉強熱心で向上心高めなんだけど目指す姿が曖昧な大学生の方に感謝の意も込めて、就職活動までサポートするプログラミングスクール「レバテックカレッジ」を紹介します。↓

Levtech-college

「自走力」のあるエンジニアを最短3ヶ月で目指せるカリキュラムが月額30,000円で用意されていて、 現段階の「目指す姿が曖昧で何から手をつければいいかわからない状態」から脱却できます。

自分は実際にIT企業で働いていますが、「自走力」のあるエンジニアの方にはいつも助けられています。

なので、目指す姿が曖昧な人はとりあえずレバテックカレッジが導いてくれる 「自走力のあるエンジニア」を目指してみるのはスタートダッシュとしてはアリです。

レベルアップしてからジョブチェンするのはRPGでも常套手段ですし、 レバテックカレッジで一通りのスキルを習得してから自分の目指す姿を再定義するといいかもです。

「自走力のあるエンジニア」って実際どんなエンジニアなの? 何から手をつければいいかわからないから教えて欲しい、 という人は上のテキストリンク/画像リンクから「無料相談会」への申し込みをお願いします。

よきエンジニアライフを!