Improve contribution guidelines

This commit is contained in:
Jason Draper 2016-08-09 13:16:17 -04:00 committed by Joshua Clayton
parent e75826f02d
commit fdf23c4664
No known key found for this signature in database
GPG Key ID: 5B6558F77E9A8118
1 changed files with 18 additions and 6 deletions

View File

@ -20,15 +20,25 @@ Here are some ways *you* can contribute:
[issues]: https://github.com/thoughtbot/factory_girl/issues
## Submitting an Issue
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.
* 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.
[gist]: https://gist.github.com/
## 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.
## Submitting a Pull Request
1. [Fork][fork] the [official repository][repo].
2. [Create a topic branch.][branch]
@ -38,6 +48,8 @@ Ideally, a bug report should include a pull request with failing specs.
## Notes
* Please add tests if you changed code. Contributions without tests won't be accepted.
* If you don't know how to add tests, please put in a PR and leave a comment
asking for help. We love helping!
* Please don't update the Gem version.
[repo]: https://github.com/thoughtbot/factory_girl/tree/master