/note/tech

レビューしやすいプルリクエスト

  • 差分の目的が1つ
    • レビューをしながら「私はいま何のレビューをしているのか」のコンテキストスイッチが発生しないので嬉しい
  • 何を達成したいのかがわかる
    • レビューの多くは「やりたいこと」と「実現方法」のすり合わせなので、前者の精度を上げたい
  • 分割されすぎていない
    • 他のコードとの関連性や構造についてのレビューがしやすい
  • レビューの強弱をつけるための情報がついている
    • 機械的な変換の差分だったりした場合、それが事前にわかると嬉しい
  • 検証結果が書いてある
    • コードだけで担保できない部分について「ほんとにこれ動くの?」とかがわかると嬉しい
  • ファイル間の関連がわかる
    • 変更したファイル数が多い場合、何が含まれていて、何がコアなのか、といった情報がわかるとレビューに取り掛かりやすい
  • この後の展開がわかる
    • マージ後のタスク(検証だったりドキュメントの執筆だったり)がわかると、それを前提にレビューできて嬉しい