Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.08 KB

Pull requests are very welcome. Please follow these guidelines (modeled after thoughtbot's):

  1. Fork the repo.

  2. Run the tests. All changes made to the code have passing tests: bundle && rake

  3. Add a test for your change/fix. Only refactoring and documentation changes require no new tests.

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

I will respond as quickly as possible and may suggest some changes, 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 or whatever is affected by your contribution

Syntax:

  • Follow the conventions you see used in the source already.
  • No trailing whitespace. Blank lines should not have any space.
  • Two spaces, no tabs.
  • 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.