2014-10-16 11:59:07 -04:00
|
|
|
We love contributions from the community! Here's a quick guide to making a pull
|
|
|
|
request:
|
2012-03-18 20:39:15 -04:00
|
|
|
|
|
|
|
1. Fork the repo.
|
|
|
|
|
|
|
|
2. Run the tests. We only take pull requests with passing tests, and it's great
|
2014-01-20 13:35:10 -05:00
|
|
|
to know that you have a clean slate: `bundle && bundle exec rake`
|
2012-03-18 20:39:15 -04:00
|
|
|
|
2014-10-16 11:59:07 -04:00
|
|
|
3. If you're adding functionality or fixing a bug, add a failing test for the
|
|
|
|
issue first.
|
2012-03-18 20:39:15 -04:00
|
|
|
|
|
|
|
4. Make the test pass.
|
|
|
|
|
2014-10-16 11:59:07 -04:00
|
|
|
5. If you're adding a new feature, ensure that the documentation is up to date
|
|
|
|
(see the README for instructions on previewing documentation live).
|
2013-03-27 09:34:05 -04:00
|
|
|
|
2014-10-16 11:59:07 -04:00
|
|
|
6. Finally, push to your fork and submit a pull request.
|
2012-03-18 20:39:15 -04:00
|
|
|
|
2014-10-16 11:59:07 -04:00
|
|
|
At this point you're waiting on us. We try to respond to issues and pull
|
|
|
|
requests within a few business days. We may suggest some changes to make to your
|
|
|
|
code to fit with our [code style] or the project style, or discuss alternate
|
|
|
|
ways of addressing the issue in question. When we're happy with everything,
|
|
|
|
we'll bring your changes into master. Now you're a contributor!
|
2012-03-18 20:39:15 -04:00
|
|
|
|
2014-10-16 11:59:07 -04:00
|
|
|
[code style]: https://github.com/thoughtbot/guides/tree/master/style
|