Skip to content
100644 39 lines (26 sloc) 1.3 KB
19bf281 @mike-burns Add a document describing how to contribute.
mike-burns authored
1 We love pull requests. Here's a quick guide:
3 1. Fork the repo.
5 2. Run the tests. We only take pull requests with passing tests, and it's great
6 to know that you have a clean slate: `bundle && rake`
8 3. Add a test for your change. Only refactoring and documentation changes
9 require no new tests. If you are adding functionality or fixing a bug, we need
10 a test!
12 4. Make the test pass.
14 5. Push to your fork and submit a pull request.
17 At this point you're waiting on us. We like to at least comment on, if not
18 accept, pull requests within three business days (and, typically, one business
19 day). We may suggest some changes or improvements or alternatives.
21 Some things that will increase the chance that your pull request is accepted,
22 taken straight from the Ruby on Rails guide:
24 * Use Rails idioms and helpers
25 * Include tests that fail without your code, and pass with it
26 * Update the documentation, the surrounding one, examples elsewhere, guides,
27 whatever is affected by your contribution
29 Syntax:
31 * Two spaces, no tabs.
32 * No trailing whitespace. Blank lines should not have any space.
33 * Prefer &&/|| over and/or.
34 * MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
35 * a = b and not a=b.
36 * Follow the conventions you see used in the source already.
38 And in case we didn't emphasize it enough: we love tests!
Something went wrong with that request. Please try again.