2017-10-20 15:20:28 -04:00
|
|
|
# Contributing to Factory Bot
|
2015-04-15 23:32:05 -04:00
|
|
|
|
|
|
|
|
We love pull requests from everyone. By participating in this project, you
|
|
|
|
|
agree to abide by the thoughtbot [code of conduct].
|
|
|
|
|
|
|
|
|
|
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
|
|
|
|
|
|
2015-08-01 23:33:45 -04:00
|
|
|
Here are some ways *you* can contribute:
|
2008-11-28 17:15:40 -05:00
|
|
|
|
2015-08-01 23:33:45 -04:00
|
|
|
* by using alpha, beta, and prerelease versions
|
|
|
|
|
* by reporting bugs
|
|
|
|
|
* by suggesting new features
|
|
|
|
|
* by writing or editing documentation
|
|
|
|
|
* by writing specifications
|
|
|
|
|
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
|
|
|
|
|
* by refactoring code
|
|
|
|
|
* by closing [issues][]
|
|
|
|
|
* by reviewing patches
|
2011-06-29 10:32:23 -04:00
|
|
|
|
2017-10-20 15:20:28 -04:00
|
|
|
[issues]: https://github.com/thoughtbot/factory_bot/issues
|
2011-08-21 21:55:47 -04:00
|
|
|
|
2015-08-01 23:33:45 -04:00
|
|
|
## Submitting an Issue
|
2016-08-09 13:16:17 -04:00
|
|
|
|
|
|
|
|
* We use the [GitHub issue tracker][issues] to track bugs and features.
|
|
|
|
|
* Before submitting a bug report or feature request, check to make sure it hasn't
|
|
|
|
|
already been submitted.
|
|
|
|
|
* When submitting a bug report, please include a [Gist][] that includes a stack
|
|
|
|
|
trace and any details that may be necessary to reproduce the bug, including
|
|
|
|
|
your gem version, Ruby version, and operating system. Ideally, a bug report
|
|
|
|
|
should include a pull request with failing specs.
|
2015-08-01 23:33:45 -04:00
|
|
|
|
|
|
|
|
[gist]: https://gist.github.com/
|
|
|
|
|
|
2016-08-09 13:16:17 -04:00
|
|
|
## Cleaning up issues
|
|
|
|
|
|
|
|
|
|
* Issues that have no response from the submitter will be closed after 30 days.
|
|
|
|
|
* Issues will be closed once they're assumed to be fixed or answered. If the
|
|
|
|
|
maintainer is wrong, it can be opened again.
|
|
|
|
|
* If your issue is closed by mistake, please understand and explain the issue.
|
|
|
|
|
We will happily reopen the issue.
|
|
|
|
|
|
2015-08-01 23:33:45 -04:00
|
|
|
## Submitting a Pull Request
|
|
|
|
|
1. [Fork][fork] the [official repository][repo].
|
|
|
|
|
2. [Create a topic branch.][branch]
|
|
|
|
|
3. Implement your feature or bug fix.
|
|
|
|
|
4. Add, commit, and push your changes.
|
|
|
|
|
5. [Submit a pull request.][pr]
|
|
|
|
|
|
|
|
|
|
## Notes
|
|
|
|
|
* Please add tests if you changed code. Contributions without tests won't be accepted.
|
2016-08-09 13:16:17 -04:00
|
|
|
* If you don't know how to add tests, please put in a PR and leave a comment
|
|
|
|
|
asking for help. We love helping!
|
2011-06-29 10:32:23 -04:00
|
|
|
* Please don't update the Gem version.
|
2015-08-01 23:33:45 -04:00
|
|
|
|
2017-10-20 15:20:28 -04:00
|
|
|
[repo]: https://github.com/thoughtbot/factory_bot/tree/master
|
2015-08-01 23:33:45 -04:00
|
|
|
[fork]: https://help.github.com/articles/fork-a-repo/
|
|
|
|
|
[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
|
|
|
|
|
[pr]: https://help.github.com/articles/using-pull-requests/
|
|
|
|
|
|
|
|
|
|
Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md
|
