ふりぶろぐ
Web Engineer's Blog
GitHub

プルリクレビューのコツ

チーム開発で品質を高める以上、Pull Requestのレビューは必ず発生します。

プルリクレビューでのコメントって結構重要だと思うんですよね。

場合によっては、相手のやる気を下げてしまう可能性もあります。

そこで、私が意識していることであったり、コツをまとめてみます。

意識していること

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

自分がされて嫌なことはしない、というのが基本です。

優しい言葉を使う

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

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

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

絵文字なんかを使って表現を柔らかくするのも良いですね。

良いところは褒める

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

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

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

あの人と一緒に仕事がしたい、と思ってもらえるキッカケにもなると思います。

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

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

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

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

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

ただ、そのソースコードに無駄があったり、統一性がなかったりした場合は指摘するべきだと思います。

読みやすい・処理の速いコードに仕上げる

最終的に目指すものとしては保守性が高く(読みやすい)、処理速度の速いものになります。

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

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

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

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

一度、こちらに目を通しておくことで基本がわかると思います。

まとめ

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

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

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

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

ABOUT ME
りーふ
たまにブログを書いてるWebエンジニア。 サーバーサイドメインでインフラとフロントエンドもたまにやります。 Javaが得意。 Play Frameworkが好き。 本業は迷惑をかけない程度に手を抜くスタイル。 意識高い系は苦手。