Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 2.3 KB
Raw

Contributing

Rules

  1. Test everything you add or fix. Functionality that is not tested is a headache to the future.
  2. Document everything you add, even a small option. If the functionality is hidden in the code, it is not useful. In general, we add a brief in the README.md and we extend the information in a file inside /docs.
  3. Avoid making Pull Requests with multiple changes. If you intend to add/fix several things, please make a PR for each one.
  4. Ask before attempting to add new features. In Platanus, we open the code of this gem to spread the happiness but we don't want to maintain things that are not useful for the company. Remember that you can always fork this gem and modify it according to your needs.
  5. Respect the style rules. We use rubocop and eslint. The rules are in the root of this gem. Any changes added to the PR because of a style rule violation should be added to the original commit in your branch with a git rebase, don't add "style fix" as separate commits.
  6. Use the template when submitting a PR

Dummy App

The gem is a Rails engine. So you have a dummy app for testing. To run the application quickly, you can execute in the root of the gem the following command:

bin/setup

This command loads the dummy app with test data. To navigate the application you can run, inside the /spec/dummy directory...

With webpack:

bin/rails s

And in another tab:

bin/webpack-dev-server

It is a good idea to add to the dummy app any new functionality. See for example the file: /spec/dummy/app/admin/invoices.rb

Testing

The gem is tested using rspec, capybara and selenium-webdriver with chrome. So, you need to have chromedriver installed. If you're using homebrew on OS X you can do: brew install chromedriver.

To run the tests you can do, in the root of the gem:

bundle exec rake tests
  • We put the addons specs inside /spec/features.
  • We put the helper classes specs inside /spec/lib.