mirror of
https://github.com/thoughtbot/factory_bot_rails.git
synced 2022-11-09 11:49:18 -05:00
Add a document describing how to contribute.
This commit is contained in:
parent
d982e6fc6b
commit
19bf281872
2 changed files with 43 additions and 0 deletions
38
CONTRIBUTING.md
Normal file
38
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
We love pull requests. Here's a quick guide:
|
||||
|
||||
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 && 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!
|
||||
|
||||
4. Make the test pass.
|
||||
|
||||
5. Push to your fork and submit a pull request.
|
||||
|
||||
|
||||
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!
|
|
@ -35,6 +35,11 @@ More Information
|
|||
|
||||
factory_girl: http://github.com/thoughtbot/factory_girl/tree/master
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
Please see CONTRIBUTING.md for details.
|
||||
|
||||
Credits
|
||||
-------
|
||||
|
||||
|
|
Loading…
Reference in a new issue