gitのコミットログをそのままプルリクの説明文にするスタイルのzaruです。こんにちは。
今回は、表題の通りgitコミットログにマークダウンを書く方法を紹介します。マークダウンを書く…といっても、自由に書けばよいと思うかもしれませんが、マークダウンの代表格である # 見出し のシャープ記号が、gitコミットログでは使うことができません。
なぜならgitではコミットログの先頭 # はコメントとして扱われ削除されるからです。
例えば以下のようにマークダウンでコミットログを書きます。
◯◯を修正
## なぜ修正したか
- AがBでCだから
### なぜβしなかったか
- αがγでσだから
# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
これは以下のようになります。
◯◯を修正
- AがBでCだから
- αがγでσだから
悲しいですね。
そこでコメントアウトの識別子を # から ; に変更します。僕が知る限り ; から始まるマークダウン記法は存在しないのと、Lispのコメントアウトで使われているので採用しました。ここは好みで何でも良いと思います。
git config --global core.commentChar ';'
こうすることでコミットログをGitHubのプルリクで見ると、装飾された読みやすい説明文が一発でできあがります。嬉しいですね。マークダウンは装飾されなくてもそのままでもある程度構造化され読みやすいのでおすすめです。
今すぐ設定して、良い感じのコミットログを書きましょう！
Discussion