🌊

新卒エンジニアがPRのレビュイー/レビュワーにおいてそれぞれ気をつけていること

2024/12/07に公開

新卒エンジニアとしてPull Request(PR)の作成やレビューに取り組む中で、特に「レビュイー(PR作成者)」として意識している点や、「レビュワー(レビュー担当)」として先輩エンジニアに意見を伝える際の工夫を紹介します。

この記事では、僕自身が日々実践していることを中心に、PRのレビュイーとして気をつけていること、レビュワーとしての取り組みについて具体的に紹介します。特に、新卒ならではの視点や悩みも交えています

🎯 レビュイー(PR作成者)として気をつけていること

1. 💭 レビューコメントを先に追記する

PRの説明に加えて、レビューコメントを先回りして書いておくことを意識しています。これにより、レビュワーが「これは何の意図だろう?」と思わなくて済みます。

僕が実践していること:

変更箇所にコメントを入れる

例えば、リファクタリングの理由や条件分岐の意図を説明するコメントを先に書いておきます。
例:「この部分では○○というケースに対応するために条件を追加しています。」

不確かな部分を明確にする

自分でも「ここは最適か分からない」と感じる部分を正直に書き、先輩に相談します。これにより、レビューの議論がスムーズになります。

2. 🎯 PRの粒度を適切に保つ

PRが大きくなりすぎると、レビュワーの負担が増え、スムーズなレビューが難しくなります。そのため、一つのPRで一つのタスクに絞るよう心がけています。

僕がしている具体例:

小さく分ける練習を重ねる

たとえば、「UI修正」と「バックエンドのロジック修正」を別々のPRに分けることで、先輩から「レビューしやすい!」と好評をもらいました。

適切なタイミングでリクエストを送る

進行中のタスクでも、「ここまでで問題ないか確認してほしい」と段階的にPRを送ることもあります。
特に、バックエンドとフロントエンドで別々のエンジニアが担当する場合があるのですが、その場合は実装の出戻りが発生しないように大体の実装ができたところでPRを見てもらうようにしています。

3. 🔍 変更箇所の動作確認を細かく行う

レビュワーが動作確認に余計な時間を割かなくても済むように、自分で十分な確認を行います
特に、テストのカバー範囲やエッジケースを見落とさないよう意識しています。

僕が気をつけていること:

具体的なテストログを残す

「この変更でレスポンスがどのように変わったか」「エラーケースでの動作結果」などを記録し、PRに添付します。
特にProduction環境のDBを直接触るようなPRでは、別途issueを立ててlogを残すようにしています。

スクリーンショットやGIFを活用

UIの変更がある場合は、スクリーンショットや操作GIFをPRに含めます。

4. 🔄 セルフレビューを徹底する

PRを出す前に、必ず自分で全てのコードと説明文を確認します。自分がミスを見つけることで、レビュワーからの指摘を減らす努力をしています。

僕がやっていること:

👀 コードの可読性を意識する

コメントや命名を確認し、「これは初見の人でも分かるか?」という視点で見直します。
特にスキーマ駆動開発を意識している弊チームでは、APIのレスポンス一つにしても命名を熟考し、その意図も一緒にコメントで書くようにしています。

🤔 レビュワー視点で疑問を想定する

「ここで疑問が出そうだな」という箇所にはコメントを添えるようにしています。

⭐️ 理想のPR

僕が理想と考えるPRは、以下の条件を満たしていると思っています:

  • PRの粒度が適切で、誰でも理解しやすい
    • スコープが狭く、内容が一目で分かる。
  • 変更箇所の動作確認が十分に行われている
    • テストや動作ログがしっかり記録されている。
  • 説明文が簡潔で明確
    • 背景・目的、変更内容、レビューポイントが揃っている。
  • レビューコメントが先回りして書かれている
    • レビュワーの疑問を最小限に抑える努力がされている。

👥 レビュワーとして気をつけていること

1. 💪 勇気を持って意見を伝える

新卒として先輩のPRをレビューするのは緊張しますが、気になったことは正直に質問します 。

僕がしていること:

質問形式でフィードバック

「この設計だと○○の場合によくないですよね?」と、意見を押し付けるのではなく、質問形式で提案します。
例:「このロジックを別のメソッドに分けると再利用性が上がると思うのですが、いかがでしょうか?」

根拠を示すためにログやドキュメントを確認

レビューする際、自分なりに動作確認やコードの実行ログを出して検証します。「自分も確認した」姿勢を見せることで、説得力を高めるようにしています。
例:「手元でも確認し、問題なく動作しました!ありがとうございます!」

2. 🌟 前向きなフィードバックを添える

「この実装、とても効率的で勉強になります!」といったポジティブなコメントを意識的に添えるようにしています。
ポジティブは礼儀とは少し違うと思っていて、相手の心理的安全性を確保するために高めれば高めるだけいいですからね

批判ではなく提案を

問題点を指摘するだけではなく、「こう書くともっと良くなるかもしれません」という形で提案します。

背景を理解する努力

なぜその実装を選んだのかを確認し、相手の意図を尊重します。

🎉 最後に

新卒としてPRのレビュイーやレビュワーを経験する中で感じたのは、「相手の視点に立つ」ことの大切さです。自分の意見を持つ勇気と、それを裏付ける根拠を準備することが、信頼を得るための第一歩だと考えています。
時には、このような嬉しいコメントをいただくこともあります:

こういった些細な褒め言葉が、新卒エンジニアのモチベーションを大きく高めてくれます。笑

お互いが気持ちよく開発できるように」と常に意識しながら、これからもPRの作成やレビューに取り組んでいきたいと思います!

Discussion