Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.85 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 an 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, stylelint and eslint. Te rules are in the root of this gem.

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

With Sprockets:

export SPROCKETS=true; bin/rails s

And if you change the javascript, you will need to run the following command:

bundle exec rake prepare_assets

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:

# For running the full setup (sprockets and webpacker)
bundle exec rake all_tests

# For running helper specs (/lib directory)
bundle exec rake tests

# For running with webpacker only
bundle exec rake webpack_tests

# For running with sprockets only
bundle exec rake sprockets_tests
  • The addons specs we put them inside /spec/features.
  • The helper classes specs we put them inside /spec/lib.

Style rules

We use Hound to check the style rules against pull requests. So, you don't need to install the code analyzers or linters if you don't want. But, don't make commits named "style fix" when the hound attacks you, or do it but use git rebase.