はじめに
こんにちは
最近某プログラミングスクールを卒業し、Webエンジニアとして転職活動している。@k4ssyi と申します。
スクール受講中の時は課題を実装したら現役のエンジニアの方にコードレビューを行って頂いてました。
その際、自分なりにちょっとした心がけでレビュアーの方に褒められたことがあったので記事にしてみました。
この記事がキッカケでプルリクエストの質が上がってコードを見る方も見られる方も気持ちよく開発出来れば良いと思います。
1. レビュー前にプルリクエストにコメント入れる
コード内に入れる程ではないけど、レビュアーにコードの意図を説明する時に記述
なぜこのような実装にしたのかコメントを入れると、レビュアも理解が早いし、よりより実装のしかたのフィードバックがもらえます。
2. 他人のコードからコピペした場合、理由をつける。
プログラミング始めたての頃は、よくわからないけどコレ使えば動くっぽいっていうロジックを書きがちだと思います。
コピーするにしても必要な部分を意味がわかった上で判断して理由を書けばレビュアーも意図がわかりやすいと思います。
3. リンターやテストは必ず通過してからレビューしてもらう
当たり前ですが、エラーが出たままこれはご法度。そもそもレビューする前にエラー出てるじゃん！って話。
でも、スクールの時はそれでプルリク出してた人もいて即突き返されたりしていたので時間の損！
4. コンフリクトしてる状態でレビュー依頼出さない。
コンフリクト起こしていると、かなり失礼と受け取られちゃいます。
初心者のころは、そもそもGitの使い方が慣れていないってのもありますが
コンフリクトはエラーみたいなもの（厳密には違いますが）なので、絶対直してからプルリク出しましょう。
5. レビュアーの時間を奪っているという認識を持つ
当たり前かも知れませんが、業務時間も限られていて
自分より上位のエンジニアに自分のクソコードを見る時間を割いてもらっていると認識することで、
レビュアーに感謝の気持ちが生まれ丁寧なプルリクが生まれると思います。
終わりに
開発はチームで行うことがほとんどですし、働き方もリモートワークを導入する企業が多くなってきたりと
何かと文字だけのコミュニケーションになりがちです。
なのでコードや文字だけで意図を明確に伝える能力が大事になりますし、
技術だけでなく、なるべくわかりやすいコミュニケーションが今後重要になってくるのかなと思います。