🐕

レビュー依頼前のセルフレビューのすゝめ

に公開

はじめに

手元で開発したものを、チームや詳しい人にレビューしてもらうことはよくあると思います。
その前に、必ず自分でも全体をざっとレビューすると良いよ。という話です。

よくある開発の流れ

手元で開発をして(最近はAIに書いてもらうことも増えましたね〜)、PR作って、CI通ったらレビュー依頼を投げて、、
おっと、依頼をする前にセルフレビューはしましたか?

セルフレビューのすゝめ

レビュー依頼する前に自分でも必ず全体をざっと見ましょう。
特に最近はAIがコードを書くケースも増えています。差分は人間が必ず確認してください。

セルフレビューすることで、以下のようなケースに気付けることがあります。よくあります。

  • 意図しない変更、変更漏れ
  • もっと良い形にできる

意図しない変更、変更漏れ

これ、本当によくあります。ざっと見るだけでも、「あれ、この変更は入れないつもりだったのに紛れ込んでた…」「ここ変更し忘れてる!」みたいなことに気付けます。

こういう、見ればすぐに気付けるようなものは直してからレビュー依頼しましょう!
レビュアーに、「なぜこうなっているんだ?何か意図があるのかな?」と無用な想像をさせてしまっては勿体無いです。

もっと良い形にできる

これも結構あります。ターミナルなどを使って普段開発をしていて、そこからGitHubなどの異なるビューで見るからでしょうか 🤔

改めて変更内容の全体を自分で見てみることで、「ここはこうした方がもっとわかりやすいな」「シンプルにできそう」みたいなことに気付きやすいです。チャンスです。

まとめ

レビュー依頼する前にざっと自分でも見直すようにしましょう。多くの時間を掛ける必要はないです。ざっとで良いので、自分できちんと目を通すことが大切です。

これだけで、ちょっとした変更漏れなどを事前に防ぐことができ、より良い状態でレビュー依頼を出せます。
結果、本来見てほしい観点(テストが適切に網羅されているか、今後の運用コストが高くならないか、など)に集中してレビューしてもらえるのではないでしょうか。

Discussion