Git

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

どうも、Kohei(@koheinishino_)です。

Gitを使い始めたけど、どういう風にコミットメッセージを書けば良いのかわからない…。

オススメのコミットメッセージの書き方を知りたい!

とお困りの方も多いのではないでしょうか。

この記事では私が使っているコミットメッセージのフォーマットを紹介し、コミットメッセージを残すときのポイントを開設します。

記事を読むことでコミットメッセージの書き方のポイントが分かり、第三者にも伝わりやすいコミットメッセージを残せるようになります。

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

私が使っているコミットメッセージのフォーマットを紹介します。

まず、具体例はこんな感じです。

コミットメッセージ(具体例)

[Add]#1 Usersテーブルの作成

ユーザー登録機能の実装に伴い、Usersテーブルを作成した。

上記のコミットメッセージは下記のフォーマットに沿って作成しました。

コミットメッセージ(フォーマット)

[Prefix]#チケット番号 コミット内容

コミットを実施した理由

順番に解説します。

コミット内容の要約を記載

1行目にはコミット内容の要約を記載します。

GitHub上ではコミットメッセージの1行目のみ表示される箇所が多いので、1行目に何のコミットなのかをわかりやすく記載しておくことは重要です。

さらに要約は3つの要素に分解します。

Prefix

Prefixにはコミットの種類を英単語1つで記載します。

基本的には下記の中から選択します。 

Prefix内容
Fixバグやミスの修正
Addファイルや機能の追加
Removeソースコードやファイルの削除
Changeソースコードやファイルの仕様変更
Updateコードや機能の改善
Upgradeパッケージやドキュメント等の更新
Revert変更の取り消し

チケット番号

次にチケット番号を記載します。チケット番号とはタスクの番号のことで、GitHubでいうとIssueの番号に対応しています。

つまり、コミットメッセージにIssueの番号を記載することでGitHub上でどのIssueに関するコミットなのかを確認しやすくなります。

コミット内容

最後にコミットの内容を記載します。

コミットにタイトルをつけるイメージで記載します。

コミットを実施した理由を記載

2行目以降はそのコミットを実施した理由を記載します。

なるべく長くなりすぎないするのがポイントです。50文字以内であれば問題ないかと思います。

コミットするときの注意点

コミットするときは1つのコミットに複数のタスクを詰め込みすぎないように注意しましょう。もし複数のタスクの一部分のみ戻したいとなったときに少々面倒なことになってしまいます。

じゃあいつコミットするのがベストなの?

と疑問に思われると思います。結論、人によって異なるため明確な答えは存在しません…w

コミットするときのタイミングには色々な切り口があります。Rubyプログラマでチェリー本の著者としても有名な伊藤淳一さんの下記の記事が参考になります。

かなり前の記事ですが、考え方は現在にも適用できると思います。

私は何かあったらここまで戻りたい!という単位でコミットすることが多いです。

まとめ:誰が読んでも理解できるコミットメッセージを残そう

コミットメッセージの書き方のポイントは下記となります。

  • 1行目にはコミット内容の要約を記載。
  • 2行目以降は箇条書きでそのコミットを実施した理由を記載。

実務ではチーム開発でGitHubを使うことが大半なので、チームメンバーが理解できるようにコミットメッセージを残しておくことが重要です。

よろしければ私のGitHubリポジトリも参考にしてみてください。

この記事を読んで、

そもそもあんまりGitの仕組みを理解できていない気がする…。

と感じた方は下記の書籍がオススメです!

イラストでわかりやすく解説されており、漫画で書かれていて読みやすいので良い意味で技術書っぽく感じずに読めると思います!

わかばちゃんと学ぶ Git使い方入門
created by Rinker
ABOUT ME
Kohei Nishino
派遣のWeb系エンジニア、ブロガーです。新卒未経験で開発エンジニアとして大手SIerに入社し1年10ヶ月で退職→派遣エンジニアとして半年間インフラ構築→派遣で開発案件探し中。現在はDevOps系の技術を勉強しており、主にRails、AWS、Docker等の学習内容を発信しています。