Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 30 lines (20 sloc) 1.098 kb
a40c6ab @mike-burns Add a document describing how to contribute.
mike-burns authored
1 We love pull requests. Here's a quick guide:
2
3 1. Fork the repo.
4
21c3308 @croaky Add Appraisal install line to CONTRIBUTING.md
croaky authored
5 2. Set up Appraisal, which helps us test against multiple Rails versions:
6 `rake appraisal:install`.
a40c6ab @mike-burns Add a document describing how to contribute.
mike-burns authored
7
21c3308 @croaky Add Appraisal install line to CONTRIBUTING.md
croaky authored
8 3. Run the tests. We only take pull requests with passing tests, and it's great
9 to know that you have a clean slate: `rake`
a40c6ab @mike-burns Add a document describing how to contribute.
mike-burns authored
10
21c3308 @croaky Add Appraisal install line to CONTRIBUTING.md
croaky authored
11 4. Add a test for your change. Only refactoring and documentation changes
12 require no new tests. If you are adding functionality or fixing a bug, we need
13 a test!
a40c6ab @mike-burns Add a document describing how to contribute.
mike-burns authored
14
21c3308 @croaky Add Appraisal install line to CONTRIBUTING.md
croaky authored
15 5. Make the test pass.
16
17 6. Push to your fork and submit a pull request.
a40c6ab @mike-burns Add a document describing how to contribute.
mike-burns authored
18
19 At this point you're waiting on us. We like to at least comment on, if not
20 accept, pull requests within three business days (and, typically, one business
21 day). We may suggest some changes or improvements or alternatives.
22
23 Some things that will increase the chance that your pull request is accepted,
24 taken straight from the Ruby on Rails guide:
25
26 * Use Rails idioms and helpers
27 * Include tests that fail without your code, and pass with it
28 * Update the documentation, the surrounding one, examples elsewhere, guides,
29 whatever is affected by your contribution
Something went wrong with that request. Please try again.