Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
良い Commit Messageを書きましょう(翻訳)

by https://github.com/erlang/otp/wiki/Writing-good-commit-messages

良いコミットメッセージは、重要な役割が、少なくとも三つあります。

  • レビューするプロセスをスピードアップする。
  • 良いリリースノートを書く手助けになる。
  • 将来、Erlang/OTPのメンテナンスを手助けするため(もしかしたら君かも!)。それは五年後の未来において、なんでコードの中で特定の変更が加えられたのか、あるいは特定の機能が追加されたのか見つけるため、ということ。

あなたのコミットメッセージの構造は次のようにするといいでしょう。

一行のラインの中で、このコミットがどういうものなのか、簡潔に要約しましょう。

このコミットでどんな問題が解決されたのか、あるいは新しい機能の使い方を記述しましょう。
あなたが特定の解決を選んだ理由をちゃんと説明しましょう。

やってね!

  • 誰かに命令しているかのように、要約行や、必要なことについて記述しましょう。例えば、"fixed",“added”,"changed"の代わりに、"fix",“add”,"change"としましょう。
  • 常に二行目を空白のままにします。
  • コミットメッセージは改行しましょう (gitk で見たときに、コミットメッセージを水平に移動させずに、読みやすくするためです)

やらないでね!

  • 要約行をピリオドで終わらせること。

Tips

もし、君のコミットが要約するのに難しいようだったら、それは複数の論理的な変更部分であったり、あるいはバグ修正が含まれているからだろうと思う。そういうときは git add -p を使って、複数のコミットに分割するといいかもね!

References

下のブログポストではコミットメッセージについていい議論がされてるよ。

On commit messages

@yuya-takeyama

This comment has been minimized.

Copy link

commented Jul 23, 2012

「要約行をピリオドで終わらせない。」という部分ですが、「「要約行をピリオドで終わらせない。」をやらないでね!」という誤読を招きやすいように思います。

「要約行をピリオドで終わらせてはいけない。」とか言うとより明確になると思いますがどうでしょう。

@esehara

This comment has been minimized.

Copy link
Owner Author

commented Jul 23, 2012

フィードバックありがとうございます。そうですね、そのほうが文意が通っていいですね。変更しておきます。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.