Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.2 KB
Raw

Contributing

We love pull requests. Here's a quick guide:

  1. Fork the repo.

  2. Create your feature branch (git checkout -b my-new-feature)

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

  4. 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!

  5. Make the test pass.

  6. Update CHANGELOG.md with a brief description of your changes under the unreleased heading.

  7. Commit your changes (git commit -am 'Added some feature')

  8. Push to the branch (git push origin my-new-feature)

  9. Create new Pull Request

At this point you're waiting on us. We like to at least give you feedback, if not just accept it, within a few days, depending on our internal priorities.

Some things that will increase the chance that your pull request is accepted is to follow the practices described on Ruby style guide, Rails style guide and Better Specs.