Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

60 lines (42 loc) · 2.23 KB
Raw

Contributing

We love pull requests from everyone.

Fork, then clone the repo:

$ git clone git@github.com:your-username/Montreal.rb.git

Set up your machine (read the appropriate README section):

$ bin/setup

Make sure the tests pass:

$ bin/rspec

Make your change. Add tests for your change. Make the tests pass:

$ bin/rspec

Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on 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:

Style Guides

This codebase is using houndci.com a hosted service that reviews GitHub pull requests for Ruby, CoffeeScript, and SCSS style guide violations.

For more information about the different style guides we try to enforce, please check the list below.

  1. Ruby
  2. Rails
  3. Testing
  4. ERB Templating
  5. Bootstrap 3 - HTML, CSS, and JS Framework
  6. Sass - CSS Preprocessor
  7. CoffeeScript
  8. Markdown
  9. Interface text should be written subjectively instead of objectively. It should be the Montrealrb.com core team addressing a person. It should be written in present time and never use past tense (has been/was). For example instead of "prohibited this user from being saved due to the following errors:" the text should be "sorry, we could not create your account because:". Also these excellent writing guidelines.