summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorJohannes Gorset <jgorset@gmail.com>2012-01-20 00:09:30 +0100
committerJohannes Gorset <jgorset@gmail.com>2012-01-20 00:09:30 +0100
commite65d0ac9e3cfa89c4c9513ff1782f22e3f976d3a (patch)
tree3b627c9736bf4d96b7af91a2a93a2e701ae90e79 /docs/dev
parent61a0e85672dfc7a3784a560b394d99914e77a010 (diff)
downloadpython-requests-e65d0ac9e3cfa89c4c9513ff1782f22e3f976d3a.tar.gz
Elaborate on how to help
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/todo.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/dev/todo.rst b/docs/dev/todo.rst
index 91c99749..4cddae56 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
---------------------