みどりのさるのエンジニア

プルリクエストのセルフレビューのススメ

2022年 05月 12日

今回は自分のプルリクエストを自分でレビューをするメリットについて話をしたいと思います。

セルフレビューとは

自分が作成したプルリクエストに対して自分でレビューをすることをここではセルフレビューと呼んでいます。

自分は複雑な実装や大きめのプルリクエストを作成した場合は、レビューをお願いする前に自分のプルリクエストを自分でレビューするといった事を偶に実施しています。

セルフレビューのメリット

  • 非効率な実装、無駄な処理、消し忘れのデバッグコード、コメントを書いておくべき箇所を見つけられる
  • レビュー時に他の人が自分のコードをどう見えているか客観的に把握できる
  • レビューで細かな点を指摘される事が減り、レビュアーの負担が軽減される
  • 細かい指摘が減ることでレビュー事態のコミュニケーション量が減るので、レビュイーの負担も軽減される

開発に集中をしていると視野が狭くなる事があるので、意外と実装後にプルリクエストを見ながら全体を俯瞰してみると、もっと効率的な書き方や読みやすい実装などに気づくことが多々あります。開発中は知識が全て頭に入っていたので理解していたコードも後で見返すと非常に理解しにくいなと感じる実装が見つかることもあり、コメントを書いておくべき箇所が見つかることもあります。

客観的にセルフレビューをすることで、レビュアーの人が疑問に感じてコメントを書きそうな場所も見えてくるので、その場合は事前に説明コメントを書いておくことで、レビュアーの負担を減らし全体のレビューにおけるコミュニケーション量を軽減できるので結果として全体のレビューの負担も減らすことができます。

このようにセルフレビューは自分の為だけでなく、レビュアーの人の為にもなります。
レビューをお願いする時は、如何にレビュアーの人の負担を減らすかを考えるのは非常に大切です。

セルフレビュー駆動開発

最初に動くコードを実装してプルリクエストを作成し、セルフレビューを実施してコメントを残して、そのコメントに対してコードを修正して改善を進めることで、セルフレビューによる駆動開発をすることもできます。

個人開発など誰かにレビューお願いしたいけど難しいパターンでは、このスタイルを試してみると意外と何もやらない時よりも綺麗なコード実装ができます。

プロフィール
筆者のアバター画像
t-yng
フロントエンドエンジニア
Githubへのリンクアイコン
タグ