[ Tips for Internship ] について
KARAPPOにインターンの学生さんが入ってきたので、教育過程で出てきたTipsのうち、一般的なことはここに書いていってみようと思います。間違ったことを教えていたら恥ずかしいのですが、自分の気持ちを引き締めるために公開してみます。なにかおかしなことがあれば、指摘していただけるとありがたいです。
一部のインターン生には、既に弊社のウェブサービスのコードにコミットしてもらっています。その中でコミットメッセージについても、注意することがありそうなので、今後も増えていきそうだし、他のインターン生にも気をつけてもらいたいので、書いておきます。
コミットメッセージで注意すること
- 文章はできるだけ簡潔に
- 敬語は不要
- 「どのファイルのどこを修正したのか」はdiffを見ればわかるので、できるだけそれ以上のことを伝えるように意識する(簡単な修正の場合は、難しい場合もあると思いますが)
- 長くなってしまう場合は、空行を使ってタイトルと本文に分ける。わけておくと、こんな感じで表示されます。