Development checklist

Development checklist.md

• Models

  • RSpec specs : update spec/models/model_name_spec.rb file
  • Factories specs : update spec/factories_spec/factories_spec.rb file
  • Factories : update spec/factories/factories.rb file
  • Sample data script : update lib/tasks/development/sample_data.rake file
  • RDoc : update app/models/model_name.rb file comments
  • Migration passing in development environment : run rake:db:migrate
  • Migration passing in test environment : run rake db:test:prepare
  • Database population passing : run rake db:populate
  • Locales : update config/locales/model_name/fr.yml & config/locales/model_name/en.yml files

• Controllers

  • RSpec specs : update spec/controllers/controler_name_controller_spec.rb file
  • Routes : update config/routes.rb file. Do not add unneccesary routes.
  • Cucumber path : update features/support/path.rb file
  • RDoc : update app/controllers/controller_name.rb file comments
  • Page title : add @page_title variable to controller responding to HTTP GET requests
  • Canonical URL : add @canonical_url variable to controller responding to HTTP GET requests
  • Sitemap : update config/sitemap.rb file (only for HTTP GET requests)

• Mailers

  • Specs : update spec/mailers/mailer_name_mailer_spec.rb file
  • RDoc : update app/mailers/mailer_name_mailer.rb file comments
  • Locales : update config/locales/mailer_name_mailer/fr.yml & config/locales/mailer_name_mailer/en.yml
  • Mail preview : update app/mailers/mail_preview.rb file

• Helpers

  • RSpec specs : update spec/helpers/helper_name_spec.rb file
  • RDoc : update app/helpers/helper_name.rb file comments

• Views

  • Cucumber specs : update features/controller_name/action_name.feature file
  • Cucumber steps : update features/steps_definitions/controller_name/controller_name_steps.rb file if needed
  • RSpec markup specs : update spec/assets/controller_name_markup_spec.rb file

• Global

  • Control script : run ./script/control
  • Security report : check reports/security_report.html
  • Best practices : check reports/best_practices_report.html
  • Locales : check locales presence (run rake locales:check if needed)
  • Update Gemfile : run bundle update
  • Annotate models : run annotate (already run in control script)
  • Encode files : run magic_encoding (already run in control script)
  • N+1 queries : check for potential n+1 queries in log/bullet.log file
  • Queries : check queries number in pages footer

Pour RDoc, est ce que il y a une commmande qui ajoute automatiquement les commentaires ou bien on ajoute les commentaires a la main ??

Il y a un autre gist avec un template : https://gist.github.com/fcarrega/f1204f1f633ddfdec009

L'idée est de se baser sur les bonnes pratiques de Tomdoc : http://tomdoc.org/

Controller:

• Page title : add @page_title variable to controller responding to HTTP GET requests
• Canonical URL : add @canonical_url variable to controller responding to HTTP GET requests
• Sitemap : update config/sitemap.rb file (only for HTTP GET requests)
• Cucumber path : update features/support/path.rb file

- Mailer:

Mail preview : update app/mailers/mail_preview.rb file

Views

Cucumber specs : update features/controller_name/action_name.feature file
Cucumber steps : update features/steps_definitions/controller_name/controller_name_steps.rb file if needed
RSpec markup specs : update spec/assets/controller_name_markup_spec.rb file

Global

Control script : run ./script/control