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

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

  • 1行目にタイトルを記入
  • 2行目は空行
  • 3行目以降に詳細を記入

コミットメッセージの書き方についてご紹介します。

コミットメッセージ、分かりやすければ良いという事なんですが、ある一定のルールがありますので、その部分だけご紹介しておきます。画面を共有します。

はい、コミットメッセージなんですけども、「1行目にタイトルを書いて、2行目に空行を入れ、3行目以降に詳細を書く」というのが慣習というふうになっております。

1行目にはまずタイトルを書くっていうのは、このように、この(SourceTree)一覧で見た時にね「何をやってるのか」が一覧で出ますから、その時に分かりやすくなるように、その1行目にはタイトルもしくは概要文をその1行でそのコミットの大まかな意味が分かる内容として書きましょう。

そして、その後に1行空けてから、その作業の詳細と言うか目的とかリンクだとか、そういったものをつけるようにします。えーとですね、ちょっとやってみますね。

「test.txt」に何か変化を加えて、コミットを書きますね。ステージしたらコミット押して、ここです。このコミットメッセージにおいて、まずは一番最初に目的とかタイトルを書きます。コミットのタイトルを書いて、そのあと1行空白を開けて、そこから説明文を書くということですね。

コミットのタイトル

コミットの詳細を書きます。

こんな風になります。もちろんここには好きなようにレイアウトしていただいても結構ですし、何かしらURLを載せていただいても結構かと思います。

これはですね、各チームによっても書き方がいろいろあるかもしれません。「全部英語でね」とか、あとは課題管理ツールと連携している場合には「必ずタイトルのコミットの部分に課題番号を書きましょう」とか、色んなルールや決まり事が各チームごとにあると思いますので、それに合わせて作業をいただければと思います。

この「コメントを書く」というのはプログラミングを行う上でも、ソースコード内に書くコメントとかも含めて、非常にセンスが問われるところで、今までのコミットは実は全くもって馬鹿げてるというかよくないコミットの履歴というような気もします。

例えば first commit から次のところで「test.txt に文言追加」なんですけども、そんなのはこの中身を見れば「test.txt」が、今、オレンジのアイコンになってますから、そりゃあ「ここに変更があったんだろうな」って分かりますし、文言追加っていうのは「じゃあ、その文言は何のために追加したのか?」っていうのが書いて欲しい内容で、例えば「何々の対応の為に、ここにテキスト追加した」とかですね。「この機能を追加する為にこのソースコードを追加した」とか、そういうふうな内容になるかもしれませんし、あまりコミットのこのログの中に色々書くのもあれだから「今、このコミットについてのやってる課題はこちらだよ」という形で決まったリンクの設定もしくはタグみたいなものを書く、と言う内容もあるかもしれません。

何にせよ、おそらく自分自身も忘れてますから(笑)、半年前のプロジェクトのコミットを見た時に、後から入ってきた人、もしくはその新しい半年後の自分が、継続した作業を、やりやすくする為に、その優しさと、なるべく理解しやすく、だからと言って冗長にならないように長すぎるとね、読むのが大変ですから、必要なことを最低限にしつつ、わかりやすく漏れないように書くという事になると途端に難しくなるんですけども、まだまだ初学の方はそこまで考えて頂かないでも結構です。

ひとまずコミットの時には、1行目にはタイトルが来るんだな、そして2行目は空行として何も書かなくして、3行目以降に説明文を書くんだな、そういうルールがあるんだな、ということだけ覚えといていただければと思います。

レッスン 受講状況
0%完了