From e84b1e502d1d279b2d3eeaa17cbd9941e6b0edab Mon Sep 17 00:00:00 2001 From: John Nunemaker Date: Sat, 30 May 2015 07:52:30 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3bac5b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +* Contributions will not be accepted without tests. +* Please post unconfirmed bugs to the mailing list first: https://groups.google.com/forum/#!forum/httparty-gem +* Don't change the version. The maintainers will handle that when they release. +* Always provide as much information and reproducibility as possible when filing an issue or submitting a pull request. + +## Workflow + +* Fork the project. +* Run `bundle` +* Run `bundle exec rake` +* Make your feature addition or bug fix. +* Add tests for it. This is important so I don't break it in a future version unintentionally. +* Run `bundle exec rake` (No, REALLY :)) +* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull) +* Send me a pull request. Bonus points for topic branches. + +## Help and Docs + +* https://groups.google.com/forum/#!forum/httparty-gem +* http://stackoverflow.com/questions/tagged/httparty +* http://rdoc.info/projects/jnunemaker/httparty