コミットするときに意識することが増えた
ふとこの自分の記事を読み返したときに、最近意識していることが増えたなーと思ったので、付け加えておく
- git commit --one-lineの１行は「何故変更したのか？」という理由をつけて、出来るだけ簡潔かつ具体的な修正内容を書く（例：N + 1問題が発生しているため、includeを追加する）
- 1.で説明しきれない内容や参考にしたURLなどは、git commitの３行目以降の補足？に記述する。
- コミットの粒度は余り大きくなり過ぎない。
これに加えて
テストコードを書く場合は、実装とテストで1コミットにしている
これをやると
- 実装した内容がどのように動作するのか？をテストコードでも見れる。レビュワーに優しい。と思う
- コミット単位を小さく意味のある単位で切るように心がけていれば、実装した内容も小さくフォーカスできて、テストの漏れも見つかりやすい
というのが、メリットかな。1コミットにテストコードも入れるので、コミットが大きくなりすぎることは気をつけないと行けないけど。
これも、最初に書いた3つの意識していることについてアドバイスしてくれた同僚の先輩が、教えてくれたこと。
これを意識してから（自分で言うのもあれだが）以前よりもPRのコミット履歴がきれいに保たれるようになった気がする。後で自分でPRを見直しても見やすい。 OSSでもこういうった所への気配りは非常に重要らしくて参考になるプラクティスだった。
話変わるけど、OSS Gateに参加して以降、OSSに関わるなにかやりたいと思って色々github上のコードを見ているけど、何も成果がない。悔しい。なにか良い題材というかネタはないものか。
