Update guide on CONTRIBUTING

As a contributor you're no longer required to add NEWS items. We'll do
that ourselves :)
This commit is contained in:
Elliot Winkler 2014-10-16 09:59:07 -06:00
parent 0dd79ced47
commit 19d628893c
1 changed files with 13 additions and 29 deletions

View File

@ -1,41 +1,25 @@
We love pull requests. Here's a quick guide:
We love contributions from the community! Here's a quick guide to making a pull
request:
1. Fork the repo.
2. Run the tests. We only take pull requests with passing tests, and it's great
to know that you have a clean slate: `bundle && bundle exec rake`
3. Add a test for your change. Only refactoring and documentation changes
require no new tests. If you are adding functionality or fixing a bug, we need
a test!
3. If you're adding functionality or fixing a bug, add a failing test for the
issue first.
4. Make the test pass.
5. Update NEWS.md with a brief description of your changes under the HEAD
heading.
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).
6. Push to your fork and submit a pull request.
6. Finally, push to your fork and submit a pull request.
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!
At this point you're waiting on us. We like to at least comment on, if not
accept, 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,
taken straight from the Ruby on Rails guide:
* Use Rails idioms and helpers
* Include tests that fail without your code, and pass with it
* Update the documentation, the surrounding one, examples elsewhere, guides,
whatever is affected by your contribution
Syntax:
* Two spaces, no tabs.
* No trailing whitespace. Blank lines should not have any space.
* Prefer &&/|| over and/or.
* MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
* a = b and not a=b.
* Follow the conventions you see used in the source already.
And in case we didn't emphasize it enough: we love tests!
[code style]: https://github.com/thoughtbot/guides/tree/master/style