レビュアーが嬉しくなるPull Requestの特徴

自分がレビュアーをしているときに、コードレビューしやすいと感じたPull Requestの特徴をまとめました。

• 変更の意図が明確に説明されている
  • コードのコメントやPull Requestの説明でなぜ変更したのかが説明されている
  • 画面に関連する変更の場合はスクリーンショットや動画、Storybookなど確認できる手段が用意されている
• コミットが適切に分割されている
• レビューの観点が記載されている
  • 見るべきところ・見なくてよいところ (考慮していないところ) が記載されている
• 変更点が少ない
  • 1つのPull Requestで目的の異なる複数の変更をしていない
• 前提情報が提供されている
  • 変更に関連する仕様書やワイヤーフレーム、関連Issueの情報
• テストが書かれている
• 動作確認方法が明記されている