/note/tech

コミットメッセージの書き方

1行目: コミットの内容を表す絵文字 + 変更内容を簡潔に英語の命令形で記述

2行目: 空行

3行目以降: なぜ変更したのか詳細な説明を日本語で記述

1行目を英語で書いて、3行目以降を日本語で書く理由↓

コミットサブジェクトの文言は英語の命令形で記述しています。これはGitが生成するメッセージに揃えるためです。( Merge pull request #1 from add_new_feature、など)

また日本語ではなく英語で記述している理由は、 何をしたか という動詞を一番最初にもってくることで、コミットの検索性を高めるためです。

日本語で記述しようとすると、 述語が文章の後ろのほうにくるため、他のコミットサブジェクトと並んだときに 何をしたか という動詞がバラバラの位置にきてしまい、コミットを探しづらくなります。

ふーむ。