コミットメッセージの良い習慣を身につける
コミットメッセージの良い習慣を身につける
チーム開発を前提として他の人が見たとき、または未来の自分が見た時に
分かりやすいコミットメッセージをつけるべきである。
基本としては下記の3点を抑える
・3行構成でコミットメッセージ書く
・内容は「更新内容」+「空行」+「更新理由」
・タイトルにはPrefixをつける
3行構成でコミットメッセージを書く
コミットメッセージは複数行で書くのが基本。
git commit -m 'message'
と mオプションを指定している場合は1行のコミットメッセージになりますが
-mを指定しない場合はvimが起動して複数行の記入が可能です。
また
git commit -m '1行目' -m '2行目' -m '3行目'
と指定することで複数行のメッセージを書くことも可能。
「更新内容」+「空行」+「更新理由」の構成
3行のコミットメッセージは更新内容、空行、更新理由という構成にします。
$ git commit
[prefix] title body
titleには「何をしたか」が具体的に分かるように。
bodyには「なぜそうしたか」という理由が分かるように書く。
titleだけで具体的に伝われば一番良いと思う。
ちなみに2行目の空行が無くてもGitHubの表示に問題は無かった。
しかしlogを取ったりする時に上手く行かない場合があるらしいのでしっかり空行は入れたほうが吉。
Prefixをつけよう
コミットメッセージにはPrefixをつけよう。
例えば、
「post_controllerを追加」
なら
[Add]post_controllerを追加
という形。
メールで件名の頭に【報告】だったり【依頼】とつけるようなイメージ。
これは開発チームで規約化するので世界標準でカチッと決まっているわけではない。
それぞれのプロジェクトに沿って運用する。
また、Prefixをビジュアルとして表現するEmoji_Prefixを使っている人も見かける。
参考リンク
GitHubのコミットメッセージに絵文字を入れて開発効率をあげる - Qiita
Emojiで楽しく綺麗なコミットを手に入れる | Goodpatch Blog
GitのコミットメッセージにEmoji Prefixを使ってテンションをあげたい話🕺💃🕺💃 - LiBz Tech Blog
Gitのコミットメッセージの書き方 - Qiita