Help us understand the problem. What is going on with this article?

gitのコミットメッセージのフォーマットを統一

More than 3 years have passed since last update.

プロジェクト毎に「コミットメッセージのフォーマットを統一します」とドキュメントに書いてもなかなか統一されてなかったりして、管理者からするとちょっとストレスになったりしますよね。

gitにはちゃんと初期設定ファイルを作れば、毎回同じコミットメッセージのフォーマットを事前に用意してくれる仕組みがあるので使いましょう。

Sampleというリポジトリで進めます。

$ pwd
=> /path/to/Sample
$ git init
$ git config commit.template .gitmessage.txt
$ vim .gitmessage.txt
---例)以下のようなフォーマッットを指定
subject line

what happened

[ticket: X]
---

これだけです。 git config コマンドの結果は、 path/to/Sample/.git/config に書かれます。

あとは、 git commit を叩いてみてください。以下のようにエディタが開くようになります。

subject line

what happened

[ticket: X]
# 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:   lib/test.rb
#
~
~
".git/COMMIT_EDITMSG" 14L, 297C
sainu
FinTechの会社で共通ID基盤システムの開発をしてます。
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away