Edited at

Railsのコードレビューをするときに確認する観点をまとめてみた

More than 1 year has passed since last update.

特に、全体を見るときに、Railsの知識があるかや、プログラミングの基礎ができているかどうかを見る際に、気にしている点をまとめた。以下ができていると、良いと判断する。


READMEの内容


  • 今後の開発に関して有益な情報を記載している


コミットログ


  • 適切な単位でコミットがされている


Gemfile


  • 定番のgemを使っている

  • groupの設定が適切になっている


config/routes.rb


  • resources を利用している

  • RESTの表現を活用して定義している


db/schema.rb


  • 正規化されている

  • ActiveRecordの標準にできるだけ沿っている

  • 制約が適切についている(booleanに default など)


controller


  • Scaffoldの実装と近い形で実装できている

  • before_action などを利用してDRYになっている

  • インスタンス変数が必要最低限になっている

  • 複雑なロジックはコントローラに記載されていない

  • あるモデルの処理は、特別なことがない限り一つのコントローラーにまとまっている


model


  • バリデーションが適切に設定されている

  • DBのカラムになっていない属性を attr_accessor で上手く活用して form からのデータを受け取れるようになっている


view


  • 複雑なロジックが含まれない

  • できるだけシンプルなHTML構造になっている

  • styleなどはcssを利用している


その他、全体で


  • ムダな記載・コードが無い

  • インデント・スペースに統一感がある

  • クラスメソッドを多用していない(クラスの責務が適切に分割されている)

  • 1メソッドあたりの行数が多すぎない

  • むやみにメソッドの引数を増やしていないこと