Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 48 lines (31 sloc) 1.566 kb
3e9527a @mike-burns a contributing guide
mike-burns authored
1 We love pull requests. Here's a quick guide:
2
df39268 @marcisme add imagemagick dependency to contributing guide
marcisme authored
3 Dependencies
4
5 Some of the tests depend on the `identify` command that comes with Imagemagick.
6 Imagemagick can be installed via [homebrew](http://mxcl.github.com/homebrew/).
7
8 brew install imagemagick
9
10 Contributing
11
1f46f26 @mike-burns Better formatting for the contribution guide
mike-burns authored
12 1. Fork the repo.
3e9527a @mike-burns a contributing guide
mike-burns authored
13
1f46f26 @mike-burns Better formatting for the contribution guide
mike-burns authored
14 2. Run the tests. We only take pull requests with passing tests, and it's great
7fe06e9 @joliss Recommend using "bundle exec" just in case
joliss authored
15 to know that you have a clean slate: `bundle && bundle exec rake`
3e9527a @mike-burns a contributing guide
mike-burns authored
16
1f46f26 @mike-burns Better formatting for the contribution guide
mike-burns authored
17 3. Add a test for your change. Only refactoring and documentation changes
3e9527a @mike-burns a contributing guide
mike-burns authored
18 require no new tests. If you are adding functionality or fixing a bug, we need
19 a test!
20
1f46f26 @mike-burns Better formatting for the contribution guide
mike-burns authored
21 4. Make the test pass.
3e9527a @mike-burns a contributing guide
mike-burns authored
22
1f46f26 @mike-burns Better formatting for the contribution guide
mike-burns authored
23 5. Push to your fork and submit a pull request.
3e9527a @mike-burns a contributing guide
mike-burns authored
24
25
26 At this point you're waiting on us. We like to at least comment on, if not
27 accept, pull requests within three business days (and, typically, one business
28 day). We may suggest some changes or improvements or alternatives.
29
30 Some things that will increase the chance that your pull request is accepted,
31 taken straight from the Ruby on Rails guide:
32
33 * Use Rails idioms and helpers
34 * Include tests that fail without your code, and pass with it
35 * Update the documentation, the surrounding one, examples elsewhere, guides,
36 whatever is affected by your contribution
37
38 Syntax:
39
40 * Two spaces, no tabs.
41 * No trailing whitespace. Blank lines should not have any space.
42 * Prefer &&/|| over and/or.
43 * MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
44 * a = b and not a=b.
45 * Follow the conventions you see used in the source already.
46
47 And in case we didn't emphasize it enough: we love tests!
Something went wrong with that request. Please try again.