# 初めてのレビュー依頼 ## コードレビューって何? プルリクエストを使って相手に自分のコードを確認してもらって共通認識を作ったり、よりよいコードを書くために行うものです。 ## コードレビューの目的 コードレビューは本来チームで開発する際に、自分が書いたコードを取り込んでもらうためにコードをチェックしてもらってバグがないか、コードや仕様がプロダクトの意図に合っているかを確認してもらうものです。 個人開発者同士でレビューを行う場合は自分のコードが他の人の環境でもきちんと動作するかを確認してもらったり、サービスに自分の視点だけではなく他人の視点を取り入れることで他の人に実際に使ってもらう際のギャップを事前になくしよりよいサービスにするために行います。 ## プルリクエストの作成時のポイント ### なるべく小さめのプルリクエストにする コード量が多いとレビューする人が確認するのが大変になってしまうのでなるべく小さく作りましょう 小さいプルリクは見る人の負担が減り、レビューが返ってくるのも早くなります [小さいプルリクでみんな幸せ](https://foo-x.com/blog/small-pr-makes-happy/) ### どんな機能を追加・改善するためのプルリクエストか伝わるようになっているか そもそも何をしているのかわからないプルリクエストはどこに着目して見ればいいのかがわかりにくくなってしまいます。 どういう目的で、どんな機能を追加しているのか・どんな改善をしているのかを書くと見る人も意図が分かった上でレビューすることが出来ます また、画面の作成や動作時のイメージなどはスクリーンショットなどで伝えるようにするとより伝わりやすいプルリクエストになります ### 環境構築方法が簡潔で伝わりやすくなっているか チーム開発などでは全員が環境構築が出来ていることが前提になるのであまりこういった観点では作成しませんが、個人開発のコードをレビューする際は環境構築方法や秘匿情報の受け渡しなどが必要になります。 自分以外も環境構築が簡潔に出来るようにしっかりと伝えるとよいでしょう ### セルフレビューをしよう レビュー依頼を出す前に自分でざっとコードを見直して意図が伝わりにくいコードがないかとか、タイプミスなどの簡単なミスがないかを再度確認しましょう。 自分でもレビューする気持ちで自分のコードを見返すのが良いかなと思います。 [セルフレビューのコツ ○](https://zenn.dev/sirosuzume/articles/64763fad0efff7) ## レビューを受ける際の意識 ### すいませんではなくありがとう コードの指摘はその人へ対する批判ではありません。 コードレビューで指摘された時に`すいません`という人がいますが、コードの指摘は批判ではないので謝るのはやめましょう。 レビューはより良いものを作るための議論の場なのですいませんではなくありがとうと伝えるとお互い気持ちよくレビューしあえます。 ### なんでもレビューされた通りに直す必要はない すべてレビュー内容通りに直す必要はありません。レビュー内容にどういった理由があるのかを確認して納得すれば取り入れれば良いし、自分が書いたコードにしっかりとした意図があってレビュー内容と比べた時に自分が書いたコードの方が適切だと思えばその理由を伝えてそのままのコードにしておいても全く問題ありません。