Edited at

コミットメッセージ | Tips for Internship 2

More than 1 year has passed since last update.



[ Tips for Internship ] について

KARAPPOにインターンの学生さんが入ってきたので、教育過程で出てきたTipsのうち、一般的なことはここに書いていってみようと思います。間違ったことを教えていたら恥ずかしいのですが、自分の気持ちを引き締めるために公開してみます。なにかおかしなことがあれば、指摘していただけるとありがたいです。


一部のインターン生には、既に弊社のウェブサービスのコードにコミットしてもらっています。その中でコミットメッセージについても、注意することがありそうなので、今後も増えていきそうだし、他のインターン生にも気をつけてもらいたいので、書いておきます。


コミットメッセージで注意すること


  1. 文章はできるだけ簡潔に

  2. 敬語は不要

  3. 「どのファイルのどこを修正したのか」はdiffを見ればわかるので、できるだけそれ以上のことを伝えるように意識する(簡単な修正の場合は、難しい場合もあると思いますが)

  4. 長くなってしまう場合は、空行を使ってタイトル本文に分ける。わけておくと、こんな感じで表示されます。
    Screen Shot 2017-01-21 at 19.04.59.png


参考