コミットについて

Gitで開発をすすめていくときに、最も基本的なコミットについて、SG流に説明していきます。

コミットするときに大事なことは変更理由と変更内容

コミットする際に大事なことは2つあります。 変更内容と変更理由です。

コミットは変更内容は意識しなくとも、後から確認することはできます。 意識すべきことは、変更内容が大きくなりすぎていないかです。

変更理由が後からわかるためには少し工夫が必要になります。

コミット内容を確認しよう

コミットする前に変更内容を確認するコマンドは2つあります。

$ git status

$ git diff

です。

ファイルがstageされているか、変更されたファイル自体を確認するには、git statusで確認できます。 addされているものについては

$ git diff --cached

で確認しましょう。

git commit するタイミングでも、

$ git commit -v

でコミットメッセージを書くタイミングで、変更内容が表示されるようになります。

変更理由をコミットメッセージに書きましょう

git diff --cached でコミットされるものが問題なければ、 git commit でコミットメッセージを書きましょう。

コミットメッセージの概要を1行目に書きます。 これは変更内容をそのまま表すものでも大丈夫です。

コミットメッセージは3行目以降を使おう

2行目はgithubやgitlabなどでは一行として表示されていまいます。 3行目以降に変更理由などを書いておくのが、SG流です。

3行名以降は、1行で書ききれなかったことを書きましょう。

変更理由や参考にした記事やドキュメントをメモしておくことで、他人にも未来の自分にもわかりやすい変更になるはずです。

もちろん変更内容が1行で住む場合は、

$ git commit -m '変更内容'

でも問題ないと思います。

git commit -v ではこんなイメージになります。僕はこんな感じでやってます。

まとめ

SG流のコミットメッセージの書き方を見ていきました。 もちろん、これだけが正解ではありませんので、より良いGitライフを送ってください。