コードレビューで大事にしたいこと

コードレビューで大事にしたいこと 2022/2/27 とにかくほめる！マウントなしのLT会林佳志乃

自己紹介名前：林佳志乃所属：エーテンラボ株式会社部署：サーバーサイド

テーマを選んだ背景コードレビューで何を大事にすべきかなんとなく考えはあったものの、明確になっていなく、そのせいでレビューにムラがあったり、優先度を間違えて後回しにしてしまったりしていたこれを機に明確にしておきたいと思った

コードレビューの目的 - コードの品質担保 - 実装者だけでなく他のメンバーも実装を理解する - 勉強

コードレビューで大事にしたいこと - issueやEPICに必ず目を通す - わからない箇所があれば質問する - 内容が難しい時はプルリク作成者に説明依頼する - 2開発日以内にレビューする -
レビューでは自分のことを棚上げする - ローカルまたは開発環境で動かしてみる

issueやEPICに必ず目を通す仕様や機能の全体像が頭にないとコードを読むのに苦戦する仕様を満たした実装になっているかをレビューするには、何のためにどんな機能を作ろうとしているのか、どんな検討をしたのかを理解してからじゃないとできないよっぽど小さな不具合修正などは別として、きちんとEPICやissueの内容を頭に入れてからレビューを行いたい

わからない箇所があれば質問するよくわからない箇所がある場合は、自分の理解力の問題もあるが、コードに問題がある可能性もある自分の理解力がなかったケースでは質問することで勉強になるコードに問題があるケースではコードの品質担保になる

内容が難しい時はプルリク作成者に説明依頼する内容が複雑だったり難しいときはレビューに時間がかかるし、億劫になって後回しにしがち効率よく理解して早くレビューをするために、内容が難しすぎる時は説明依頼をするようにしている説明依頼は相手の時間を取ってしまい、申し訳ないな〜と感じたりするが、レビューまで時間がかかりすぎたり、ぼんやりした理解のままLGTM出すよりは良いと考えているだいたい快く丁寧に教えてくれるし、一人で調べてレビューするより断然短時間で理解が深まると感じている

2開発日以内にレビューするレビューする = 変更差分を一通り確認してコメント or LGTM するプルリクが滞留している時間が長いとリリースが遅れるし、rebaseが大変になるし、健全じゃない会社の開発メンバー間でのWorking
Agreementになっているが、私はあまりできていない汗これからはもっと2開発日以内のレビューを守っていきたい

レビューでは自分のことを棚上げするこれも、会社の開発メンバー間でのWorking Agreementになっている自分ができていないことを他の人に指摘するのは、申し訳ない気持ちになるが、コードの品質を保つためには自分ができていないことでも、気になったことは指摘する必要があるチーム内で合意が取れていると少し気が楽 https://qiita.com/jnchito/items/0a0b46106681f41f2f0e の記事が、レビューでは自分のことを棚上げする大事さについて詳しく解説してくれている

ローカルまたは開発環境で動かしてみるプルリクだけ見ればレビューできそうな小さな変更でも、意外と問題を見逃してしまうことがあるローカルや開発環境で動かしてみて、「なんかレスポンスとして返る値が違いそうだぞ」「うまく画面が描画されないぞ」などと気づくことがある

ご清聴ありがとうございました

コードレビューで大事にしたいこと

コードレビューで大事にしたいこと

hayashiyoshino

More Decks by hayashiyoshino

Other Decks in Programming

Featured

Transcript