diff options
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..e4ed3ae --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,62 @@ +# Hacking on HTTPretty + +## creating a virtual env + +you will need [virtualenvwrapper](http://www.doughellmann.com/projects/virtualenvwrapper/) + + +```console +mkvirtualenv --distribute --no-site-packages HTTPretty +``` + +## installing the dependencies + +```console +pip install -r requirements.pip +``` + +## next steps + +1. run the tests with make: +```bash +make unit functional +``` +2. hack at will +3. commit, push etc +4. send a pull request + +# License + + <HTTPretty - HTTP client mock for Python> + Copyright (C) <2011-2013> Gabriel Falcão <gabriel@nacaolivre.org> + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + + +# Main contributors + +There folks made remarkable contributions to HTTPretty: + +* Steve Pulec ~> @spulec +* Hugh Saunders ~> @hughsaunders +* Matt Luongo ~> @mhluongo +* James Rowe ~> @JNRowe |
