Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.42 KB

Contributing

Contribute your code to ComfortableMexicanSofa in 5 easy steps:

1. Fork it

Fork the project. Optionally, create a branch you want to work on.

2. Get it running locally

  • Install gem dependencies with bundle install
  • There's nothing to configure, by default database is SQLite so it will be created for you. Just run bundle exec rake db:migrate
  • Make sure that existing tests are passing by running bundle exec rake test
  • There are system tests that can be run with bundle exec rake test:system. You need to have chromedriver installed for that.
  • You should be able to start the app via bin/rails s and navigate to http://localhost:3000/admin

3. Hack away

  • Create a few small pull requests instead of a humoungous one. I can merge small stuff faster.
  • When adding new code just make sure it follows the same slyle as the existing code.
  • Avoid adding 3rd party dependencies if you can.
  • Tests please, but nothing complicated. UnitTest / Fixtures all the way. Make sure all tests pass.
  • Run bundle exec rubocop and fix any issues raised.

4. Make a pull request

5. Done!

If everything is good your changes will be merged into master branch. Eventually a new version of gem will be published.