2014-05-26 23:43:06 -04:00
|
|
|
# Contributing
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
We love pull requests. Here's a quick guide.
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
Fork, then clone the repo:
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
git clone git@github.com:your-username/factory_girl_rails.git
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
Set up your machine:
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
./bin/setup
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
Make sure the tests pass:
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
rake
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
Make your change. Add tests for your change. Make the tests pass:
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
rake
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
Push to your fork and [submit a pull request][pr].
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
[pr]: https://github.com/thoughtbot/factory_girl_rails/compare/
|
2011-07-22 17:12:50 -04:00
|
|
|
|
2014-05-26 23:43:06 -04:00
|
|
|
At this point you're waiting on us. We like to at least comment on 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:
|
|
|
|
|
|
|
|
|
|
* Write tests.
|
|
|
|
|
* Follow our [style guide][style].
|
|
|
|
|
* Write a [good commit message][commit].
|
|
|
|
|
|
|
|
|
|
[style]: https://github.com/thoughtbot/guides/tree/master/style
|
|
|
|
|
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
