From e65d0ac9e3cfa89c4c9513ff1782f22e3f976d3a Mon Sep 17 00:00:00 2001 From: Johannes Gorset Date: Fri, 20 Jan 2012 00:09:30 +0100 Subject: [PATCH] Elaborate on how to help --- docs/dev/todo.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/dev/todo.rst b/docs/dev/todo.rst index 91c9974..4cddae5 100644 --- a/docs/dev/todo.rst +++ b/docs/dev/todo.rst @@ -3,6 +3,25 @@ How to Help Requests is under active development, and contributions are more than welcome! +#. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. + There is a Contributor Friendly tag for issues that should be ideal for people who are not very + familiar with the codebase yet. +#. Fork `the repository`_ on Github to start making your changes to the **develop** + branch (or branch off of it). +#. Write a test which shows that the bug was fixed or that the feature works as expected. +#. Send a pull request and bug the maintainer until it gets merged and published. :) + Make sure to add yourself to AUTHORS_. + +Development dependencies +------------------------ + +You'll need to install ``gunicorn`` and ``httpbin`` in order to run requests' test suite:: + + $ pip install gunicorn + $ pip install httpbin + + + What Needs to be Done --------------------- -- 2.7.4