初心者向け

【GitHub】Pull Request(プルリクエスト)レビューで意識していることTOP3!

こんばんは!光です。

大手グローバル企業でWebエンジニアをやっています。

Webエンジニアを目指してプログラミングを勉強している初心者の方向けに情報を発信しています。

経歴や実績はこちら

システム開発のお仕事の依頼もお待ちしております。

お問い合わせページTwitterのDMからお気軽にお問い合わせください!

今回はこのような質問をいただきました。

プルリクのレビューって何を意識したら良いのかイマイチわからない…

レビューって慣れるまで結構難しいんですよね。

そこで今回はこちらの質問について解説していきます!

意識していることTOP3!

私はどちらかというと技術的な面よりも精神的な面を重視しています。

  • 自分がされて嫌なことはしない
  • 自分がされて嬉しいことはする

というのが基本です!

言葉をしっかり選ぶ!

まずこれは大前提ですよね。

トゲのある言葉でレビューされたら修正する気すらなくなります。

ここ直しておいて

と言われるより

〇〇なのでここは修正してもらえますか?
何か困ったことがあれば質問してください!

と言われるほうが直す気にもなりますよね。

メンバー間のコミュニケーションを円滑にするためにも言葉はしっかりと選びましょう

絵文字とか記号(!, 〜)とか積極的に使うと更に良き!

何か指摘するときはなぜその指摘をするのかを伝えるのもポイントです!

良いところは褒める

こちらを行っている人はあまりいないイメージがあります。

レビューは問題点を指摘するだけでなく、良い箇所を褒めても何も問題はないです。

むしろ、褒めたほうがやる気にもつながるので良いところは積極的に褒めましょう

〇〇さんとと一緒に仕事がしたい!

と思ってもらえるキッカケにもなります!

これ、めちゃくちゃ有効なので是非実践してみてください!

自分のこだわりは無視する

自分のこだわりまで指摘してしまうと指摘箇所が多くなってしまいます。

ここでの改行は不要だとか、変数名、メソッド名が気に入らないとか…

人それぞれ性格が違うようにソースコードも違います。

性格が表れる部分だと思うので、自分のこだわりは捨てましょう

このような場合は指摘するのではなく、こういう書き方もあるのかくらいに考えて自分の成長へつなげたほうがためになると思います。

ただ、無駄があったり、統一性がなかったりした場合は指摘するべきですね!

高品質なコードを目指そう!

最終的に目指すコードは以下のようなコードです。

  • 読みやすい
  • 保守性が高い
  • 処理速度の速い

技術的な指摘という意味ではこれらを意識することで何を指摘したら良いか見えてくると思います。

ただ、慣れないうちはどのようなコードが良いコードなのかわからない場合もあります。

そんなときは他の人のコードを参考にしたり、調べてみたりすることが大切です。

もし信頼できるエンジニアがいるなら、その人のコードを参考にすることをおすすめします!

私は入社した際に、こちらの書籍をいただきました。

こちらに目を通しておくことでどのようなコードが良いコードなのかわかるようになります!

あとがき

たかがコードレビューとはいえ、相手を思いやる気持ちは大切です。

相手のやる気を高めるようなコードレビューを心がけるべきだと思います。

互いに互いを思いやり、良い関係でチーム開発を行いたいですね!

品質の高いものに仕上げるために、非常に重要なことだと思っています。