レビューとは
そもそもレビューとは、コードがやりたいことを正しく・安全に・読みやすく実現できているかを確認する作業。
レビューできるようになるには「コードの意図と影響範囲を正しく把握できるか」が大事らしい。
この7つわかれば、自分で最低限レビューできるようになるはず！と考えてまとめました！
そのために見るべきは以下の７つ！
- 仕様との一致
- 責務の分離
- 安全性
- 変更の影響範囲
- 読みやすさ
① 入口（送信元）
- どの画面・どの操作から呼ばれる？
- URL / HTTPメソッドは正しい？
入口の確認！
② route
- 送信元と一致している？
- 想定外のメソッドを許可していない？
ルーティングの確認！
③ controller
- 役割が混ざってない？（ビジネスロジックが肥大化してない）
- 使わない分岐がない？
- 他ユーザーのデータに触れない？
コントローラの責務チェック！
④ response(view / JSON)
- 必要なデータだけ返している？
- エラー時のレスポンスが握りつぶされていない？
レスポンスの確認！
⑤ 変更の影響範囲
- 未変更スキップがある？
- 既存機能を壊していない？
- テストが必要な箇所はどこ？
影響範囲の見極め！
⑥ セキュリティ
- 権限チェックはある？
- 他ユーザーのデータにアクセスしていない？
- パラメータを信用しすぎていない？
セキュリティ観点！
⑦ 可読性
- 変数名・関数名が意図を表している？
- コメントが必要な箇所だけにある？
未来の自分が読んで理解できるかが可読性の基準！