Permalink
Fetching contributors…
Cannot retrieve contributors at this time
56 lines (38 sloc) 1.84 KB

We love pull requests from everyone. We expect users to follow our Code of Conduct while submitting code or comments.

Contributing

  1. Fork the repo.

  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate:

bundle install
cd test/dummy
bundle exec rspec spec
bundle exec cucumber features
  1. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!

  2. Make the test pass.

  3. Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:

  • Use Rails idioms and helpers
  • Include tests that fail without your code, and pass with it
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution

Syntax

  • Two spaces, no tabs.
  • No trailing whitespace. Blank lines should not have any space.
  • Prefer &&/|| over and/or.
  • MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
  • a = b and not a=b.

In order to better comply with the complete guidelines, there is a separate project with configuration files for linting different programming languages.

These guidelines mention the state that we'd like the project to be in. If you find older parts of the code, which might be below our common requirements feel free to update it.

Thanks for your contribution. It means a lot to us.