最近、Pull Request（PR）のレビューに関して思うことがありました。
これはチーム開発において「PRレビューする側の気持ち」を少しでも楽にしてほしいという願いから書いています。
レビューする人の時間は有限です。
読みやすく、伝わりやすいPRを意識してみましょう！
※ 日頃からすべて意識している人は本当すばらしいと思います！当てはまる項目がないか、ぜひセルフチェックしてみてください🙇♂️
1. 大量の変更を1つのPRで対応する
「変更箇所が広い」「チケットが複雑」という理由は理解できます。
ですが、1週間〜2週間かけて実装したPRのレビューには1〜2時間以上かかることも少なくありません。
想像してほしいです。１つのPRを2時間以上かけてチェックすると、どんな気持ちになりますか？
例えば以下のように分割できないか、事前に検討してほしいです。
✅ 対応方法
実装前にチケット内容を確認し、「分割して実装できないか？」を考えてみましょう！
2. 実装の意図が記載されていない
⚠️ PRテンプレートを無視しないでください。
「ライブラリの導入」や「複雑な実装の追加」、「既存コードの変更」などは、一言でも良いので意図の説明を残してほしいです。
「このような要件」に対して、こんな「変更・追加実装」を行いました！
このようなコメントがあるだけで、レビュワーの理解がかなりスムーズになります。
✅ 対応方法
PRに適宜コメントを追加しましょう。
要件が曖昧な場合は、チケット作成者に確認してください。
3. 仕様の確認が曖昧なまま実装している
「実装上で気をつけるべきポイント」や「実装後のゴール」を確認できていないケースがあります。
これは「動作確認」や「テストコード」にも影響します。
仕様は、実装前や実装中にしっかり意識してほしいです。
レビュー時に「要件確認→修正依頼→対応確認」のサイクルが発生するのは、なるべく避けたいです。
✅ 対応方法
前項（2）と同じく、「レビューで指摘されたら直せばいい」という考えは捨てましょう。
4. 既存の実装方法を考慮していない
似たような実装がすでにあるのに、まったく無視して書かれていると…
- レビューしづらい
- 可読性が下がる
などの問題が出てきます。
もちろん「可読性向上」や「パフォーマンス改善」のための工夫は歓迎ですが、その理由はコメントに残してください。
✅ 対応方法
「既存実装が酷すぎる」などの例外を除き、チームの実装ルールや統一感を意識した実装を心がけてください。
5. レビューコメントに対しての返答がない
「上記すべて対応しました〜」だけで終わる人、いますよね？
これ、レビュワーにとっては困ります。
細かくレビューを出した際には、以下のように伝えてくれると本当に助かります。
- どのレビューコメントに
- どのコミットで
- どんな対応をしたのか
✅ 対応方法
丁寧なコミュニケーションを心がけましょう。
レビュワーも人間です。
6. 動作確認を十分に行っていない
PRを確認すると、要件通りに動いていないケースがあります。
- 要件の理解不足？
- 実装漏れ？
理由はわかりませんが、イラっとします。
「これ、本当に動作確認しました？」と思うこともあります。
✅ 対応方法
すべてに証跡を残す必要はありませんが、PRを出す前に最低限のチェックは行ってください。
7. 動作確認方法などが記載されていない
これは特に「CSV出力」などの画面上で確認しにくいケースでありがちです。
確認手順と、1ケースの動画があるだけで、かなり助かります。
面倒に感じるかもしれませんが、レビュワーはもっと面倒なんです。
✅ 対応方法
動作確認手順はしっかり記載しましょう。
（該当URL、必要データ、確認方法など）
番外編：PRとは直接関係ないけど…
以下のような人は「ちょっと気遣いが足りないな…」と感じます。
- 質問する前に確認事項が整理できていない
- チャットで済む内容を直接聞く
- →「自分が何をわかっていないか」を相談相手に考えさせている
- → 言語化の手間を相手に押し付けている
事前に一言でも良いので
「このコードについて確認したいです！」
「困っていることは〇〇です」
と伝えるだけで、相談を受ける側の負担がグッと減ります。
まとめ
レビューする人の気持ちを考えたPRを作りましょう。
今回紹介した「やってほしいこと」は、できている人は常にできています。
逆に、できていない人は複数項目が同時にできていないことが多いです。
この記事を読んで、「PR作成時に気をつけている点」や「レビュー時にみやすいと思う工夫」等があれば、ぜひコメントで教えてください🙌
株式会社シンシア
株式会社xincereでは、実務未経験のエンジニアの方や学生エンジニアインターンを採用し一緒に働いています。
※ シンシアにおける働き方の様子はこちら
シンシアでは、年間100人程度の実務未経験の方が応募し技術面接を受けます。
その経験を通し、実務未経験者の方にぜひ身につけて欲しい技術力（文法）をここでは紹介していきます。
Views: 0
