5
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

複数リポジトリのコミットコメントルールで混乱しないためのGitTips

Posted at

困ったシーン

コミットコメントのルールはプロジェクトや会社に応じて様々なものがあると思います。
複数の異なるルールで運営されているリポジトリをいったりきたりしているとき、
いざコミットする段階になって、「あれ、ここでは日本語だっけ、英語だっけ...」と時々混乱してしまいます。
こういう時のためには、コミットテンプレートを活用すると便利です。

参考

設定方法

まず、テンプレートとなるtxtファイルを準備する必要があります。
もしチーム内で合意が取れている場合はtxtファイル自体をgit管理に含めても良いと思いますが、
自分の場合は個人的オレオレルールもあったりするので、自分のローカルに適当に置いています。

$ mkdir ~/gitmessages
$ vi ~/gitmessages/.template.txt
~/gitmessages/.template.txt

# Please write in English!

作った設定ファイルをgitに設定します。

$ cd /move/to/project/dir
$ git config commit.template ~/gitmessages/.template1.txt

すると、コミットコメント記入時にテンプレートの内容が反映されます。

スクリーンショット 2017-09-05 22.23.56.png

テンプレートの1行目をあえて空けておいて、
2行目の先頭に # 何か文章 と書くと、記入のためのヘルプメッセージとして扱うことができます。
(このテクニックは @norifumi さんにアドバイスいただきました。ありがとうございます!)

こんな感じに使ったりも便利です。

~/gitmessages/.template2.txt
【番号】 

# 【番号】にはチケット番号を記入してください。
# ... (他にも重要なルールなどを書いたり) ...

スクリーンショット 2017-09-05 22.52.28.png

5
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
5
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?