【必須】Gitコミットの書き方・作法【prefix/emoji】

こんにちは。iQeda [@iQeeeda] です。

新しいプロジェクトにジョインしたら、チームの Git 運用ルールを頭に入れると思います。
技術的に尖っている現場だと、最初のコミットはちょっと緊張しますね…

…と知っているだけで、いざというとき心に余裕があるはず。きっと。

一般的なコミット作法をおさえよう

作法は「ただのマナー」です。必ずしも従う必要はありません。
しかし多くの開発者は一般的な Git 作法に従ってチーム作業を効率化しようとしています。

「3 行ルール」がコミットメッセージのフォーマット

コミットメッセージのコツは 3 行で書くことです！

1行目：コミット内容の要約（タイトル・概要・issue/チケット番号）
2行目：空行
3行目以降：本文 （内容・詳細・変更理由・issue/チケット番号）

ただし 1 行目の要約で全てが伝わるなら 2 行目以降を省略することもあります。
以下はサンプルです。

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

このコミットメッセージ 3 行ルールを深堀り解説しますね。

一行目

コミット内容の要約

prefix (接頭辞) emoji (絵文字) を付けると可読性が上がる

この prefix のメリットは以下のようなものが挙げられます。

prefix 一覧

よく使われている prefix をまとめてみました。
チームで相談して使いやすい prefix だけ採用するといいでしょう。

emoji

コミットメッセージの中では絵文字を使うことができます。

たとえば 🐛 (メッセージ内では :bug: と入力) という絵文字が付いていたら、

と、ひと目で分かりますね。

コミットメッセージ内で絵文字を表現する方法について

絵文字の名前ですが、以下サイトのチートシートで調べるのが便利ですよ。

コミットのテンプレート作成

毎回 prefix や絵文字を調べるのは手間なので、テンプレートで常に確認できるようにします。

~/.commit_template というファイルを作成してください。
このファイルの中に好きなだけメモしましょう。(絵文字も使えます)

たとえば、こんな感じです。

# ==== Prefix ====
# fix
# feat
# docs
# style
# refactor
# test
# chore

# ==== Emojis ====
# :bug:         バグ修正 (fix)
# :+1:          機能改善 (fix/feat)
# :sparkles:    部分的な機能追加 (feat)
# :tada:        盛大に祝うべき大きな機能追加 (feat)
# :rocket:      パフォーマンス改善 (feat)
# :lock:        新機能の公開範囲の制限 (feat)
# :cop:         セキュリティ関連の改善 (feat)
# :note:        ドキュメント修正 (docs)
# :shirt:       Lintエラーの修正やコードスタイルの修正 (style)
# :recycle:     リファクタリング (refactor)
# :shower:      不要な機能・使われなくなった機能の削除 (refactor)
# :green_heart: テストやCIの修正・改善 (test)
# :up:          依存パッケージなどのアップデート (chore)

作ったテンプレートファイルを設定します。

git config --global commit.template ~/.commit_template

これでコミットメッセージ作成時にテンプレートが読み込まれます。

二行目

空行にする

二行目を空行にする理由を説明しておきます。

GitHub などのコメント表示と差異がないようにするため 2 行目は空行にしておく、
という他ユーザへの配慮が必要なのです。

三行目

本文

不具合の管理番号を明示することがある

プロジェクトでは Redmine や JIRA のようなサービスで不具合を番号管理することがあります。
いわゆる BTS (バグトラッキングシステム) です。

refs は references (参照) の略です。

ということを表せるのですね。

GitHub Issues

BTS も便利ですが、GitHub の Issues 機能で不具合管理してる場合、
コミットメッセージの中で Issue 番号を明示できます。

GitHub 上で「コミットメッセージの Issue 番号をクリック」すると、
該当の Issue ページにジャンプできます。

コミットで Issue をクローズできる

また Fix#Issue番号 や Close#Issue番号 のように書くと、
プルリクがマージされたとき Issue を解決することができます。

クローズキーワードを使うとき、誤字脱字に注意！

こういったクローズキーワードの類は便利ですが、誤字脱字すると動かないので注意してください。

大事な情報はプルリクにまとめる

コミットメッセージに色々と書いてくれるとありがたいのですが…
自分が思っているほど、他人はちゃんと読んでくれません!

Markdown の書き方は…

関連記事