コードレビューで今後気をつけること

最近、自分のコードレビューがイケてないなーっと思うことがあったので、今後気をつけることをメモがてらにまとめようと思います。

コードレビューを依頼するときに気をつけること

単純にレビューを依頼しただけではスムーズに終わらないケースもあるので、以下のポイントを気をつけていきます。

最終的なコードと動作のチェックを2度する

ケアレスミスや動作確認をしていれば気づける不具合の指摘は、レビュワーの負荷にもなるので、減らせるように気をつけていたいと思います。
特に私は1度ミスするタイプの生き物なので、時間を置いて2度確認することで見落としを減らしていきたいです。

相手の立場に立ったPRの説明をする

最近、「〇〇だから△△した理解で合っているよね？」っと聞かれるケースが何度かあったのですが、これは「どのように解決したのか」という観点の説明が浅いせいだなっと最近思うこの頃です。
相手の立場に立って、疑問を持たれない説明になっているか考えながら説明を書くように気をつけたいと思います。

より見てほしいところはコメントをする

コード量が多かったりするとレビュワーも見切れないケースがあるので、

1. 動作に不安がある箇所
2. もうちょっと上手く書けないか相談したい箇所

など、より見て欲しいところはコメントで主張していきたいと思います。

コードレビューをするときに気をつけること

自分が思っていることと相手の受け取り方が全然違ったりするので、以下のポイントを気をつけていきます。

自分の意見を伝えた上で質問する

「これは必要ですか？」のように質問だけで終わらせるのはちょっと冷たい印象で捉えられるのと、議論が進みにくいコメントだなっと最近思うこの頃です。
「自分だったらこうするけど、これは必要ですかね？」のように自分の意見を伝えた上で質問した方が議論が進みやすそうなので、気をつけていきます。

優先順位を伝える

コメントの数が多いと、どのコメントから対応したらいいか困るケースが自身でありました。
なのでコメントは、修正が必須か推奨か、それともただ質問なのか明確に伝えることを気をつけていきます。

否定的な伝え方をしない

「〇〇にしてください」のような伝え方は否定的に捉えられやすいです。「〇〇のようにすると良いかもですね」のように否定的な伝え方にならないように気をつけていきます。

まとめ

レビューする側・される側に共通することは「相手の立場で考える」だと思います。この辺りを十二分に意識して、相手を敬いながら生きていきます！！！