GitHub で issue を管理していると、コミットログで issue 番号を参照したくなる。

#1234 - Fix this issue ...

しかし、デフォルトで Git のコミットログは先頭が # から始まる行はコメントになるので、上記のように入力できない。そんなときは、Git の設定パラメータ core.commentChar を使ってコメント文字を変更する。

$ git config core.commentChar '>'

グローバルで変更を適用したかったら、--global を付けてもよい。

Vim のハイライト設定

Vimmer であれば、コメント文字を変更したら、vim のハイライト設定も変えたくなる。.vimrc に以下のように設定する。

au FileType gitcommit syntax match gitcommitComment /^[>"].*/

上記の設定では、# に加えて、> と " がコメントとしてハイライトされるようになる。

参考