kawasaki-shohei/review_in_english

DICコードチェック基礎編に準拠させる

Opened this issue · 0 comments

norotime commented

コードの可読性

  • Gemfileはコメント行をあらかじめ消す
  • 改行は意味のある単位でのみ行う
  • 意味のない空行は消す
  • ロケット記法は使わない（ NG :hoge => true 、OK hoge: true）
  • 変数やアソシエーション名は中に入る内容や機能に関連した名前づけをする
  • 変数やメソッド名は、スネークケースで記述する
  • 省略した命名は使わない
  • privateより下の行はprivateと同じレベルのインデントにする
  • ストロングパラメータに関するコメントは削除する
  • updateアクション等ではコールバックや例外処理も記載する
  • コーディング規約を遵守する http://www.ruby.or.jp/ja/tech/development/ruby/050_coding_rule.html

実装方法

  • スタイルはclassに当てる

無駄のないアプリケーション構成

  • Rspecを使うならtestディレクトリは消す
  • 不要なcssやjsのファイルは削除する（config/application.rbでassetsの自動生成の抑制もできる）
  • createアクションでrespond_toを使わなくなったのであれば削除をする
  • scaffoldで生成されるcssは使わないのであれば削除する
  • APIサーバとして使わない場合は json系のrespond_to周りは削除する

初期設定

  • アプリケーションを作成する際、.envの設定は基本的に最初に済ませる
  • タイムゾーンの設定は日本にする
config/application.rbにて
config.time_zone = 'Tokyo'
config.active_record.default_timezone = :local の設定をする

Gitの使い方。共同作業の際の注意点

  • コミットは小さく一つひとつの作業ごとにする
  • コミットメッセージは何の作業をしたのかを詳しく記述する（日本語でも良い）
  • イシュー名、プルリクエスト名は必ず意味のある名前にする