コードレビューをする時に心がけている3つのこと

1 min read読了の目安(約700字

1. 否定しない

否定的なコメントは避けるようにしています。
わざと悪いコードを書こうとする人はいないと思っています。レビュイーが自分で考えた最善のコードを書いてくれていると思い、敬う気持ちを忘れないように心がけています。

- NG: この書き方はわかりづらいです。このように書いてください。

+ OK: このように書いたら、さらにわかりやすくなりそうですね。

2. 優先順位をつける

コメントの数が多くなってくると、レビュイーはどのコメントから対応したらいいか、わからなくなってきます。
コメントに以下のプレフィックスをつけて、優先度と、どのように対応するべきかを示すように心がけています。

優先順位 プレフィックス 意味
1 must 必ず対応する。
2 should 可能であれば対応する。
3 nits 細かい指摘。個人的にはコメントの誤字脱字を見つけた時とかに使います。
4 imo in my opinionの略。このままでもいいけど、自分だったらこうする。

3. 最後まで見届ける

コメントをしたら放置せず、どのように対応されたかを確認して、最後まで見届けるよう心がけています。
レビュイーは、コメントに対して正しく修正できているか気になっています。修正確認後にresolveするまでがレビューです。


この三点を意識するだけでチーム内外からのレビュー依頼や実装方法の相談が増えました。
全てに共通することは「相手のことを考える」というシンプルなことです。