From 911890073fe2beca22aca22b7768e577f63cee54 Mon Sep 17 00:00:00 2001 From: Joshua Clayton Date: Sat, 1 Aug 2015 23:33:45 -0400 Subject: [PATCH] Improve CONTRIBUTING.md --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bcdcfa1..5f30740 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,13 +5,44 @@ agree to abide by the thoughtbot [code of conduct]. [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct -To contribute to Factory Girl: +Here are some ways *you* can contribute: -1. Fork the [official repository](https://github.com/thoughtbot/factory_girl/tree/master). -2. Make your changes in a topic branch. -3. Send a pull request. +* 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 -Notes: +[issues]: https://github.com/thoughtbot/factory_girl/issues -* Contributions without tests won't be accepted. +## 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. + +[gist]: https://gist.github.com/ + +## 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. * Please don't update the Gem version. + +[repo]: https://github.com/thoughtbot/factory_girl/tree/master +[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