rastam’s blog

東京在住のマレーシア人 Rubyist

コードレビューで聞く質問集

コードレビュー中には、どこを見ればいいんだっけ、ってよくなりますので、 まとめておきました 英語でまとめたものを日本語に訳しました。

  • この PR の目的は何なの?
  • PR 作成者がこの PR に到るまでの調査結果・決定事項・仮説は妥当か?
  • もっといい解決方法はないか?コード修正以外の解決方法も検討。
  • この PR は根本的な解決?それとも暫定対応?暫定対応の場合は、PR 作成者に根本的な解決の計画を立ててもらう。
  • この変更点はステークホルダーにどんな影響を与えるか?ステークホルダーはエンドユーザだけでなく、チームメンバーとかも含まれてる。
  • その影響は最小限に抑えられないか?
  • 影響を最小限に抑えるには、具体的にどんなステップを取るか?
  • この PR の動作は正しいか?(言うまでもない)
  • 足りてないエッジケースはないか?
  • セキュリティの穴はないか?
  • コードをもっと読みやすくできないか?
  • コードをもっと簡潔に書けないか?
  • 削除できる不要なコードはないか?
  • PR 作成者にもしものことがあったら、レビュワーである あなた はこのコードを引き継ぐ責任は取れるか?
  • マージ前後にやることはないか?特に CI やチームメンバーの開発環境に影響を与える修正。
  • オンラインメンテでデプロイできそうか?
  • デプロイ前後にやることはないか?PR 作成者にチェックリストを書いてもらう。

下記項目は基本確認しないようにしている。

  • コード規約・フォーマット。Rubocop などのリンターに任せましょう。
  • テスト。上記項目の確認がぜーんぶ終わったら、テストまで確認する気がほとんど失せてるから。

このレビュー術は、Aiming で培ってきたものです。