LoginSignup
0
1

More than 5 years have passed since last update.

@naokazuterada(Terada Naokazu)inKARAPPO Inc.

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

Last updated at Posted at 2017-01-21

[ Tips for Internship ] について

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

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

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

  1. 文章はできるだけ簡潔に
  2. 敬語は不要
  3. 「どのファイルのどこを修正したのか」はdiffを見ればわかるので、できるだけそれ以上のことを伝えるように意識する（簡単な修正の場合は、難しい場合もあると思いますが）
  4. 長くなってしまう場合は、空行を使ってタイトルと本文に分ける。わけておくと、こんな感じで表示されます。 Screen Shot 2017-01-21 at 19.04.59.png

参考

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
1