aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Kriechbaumer <thomas@kriechbaumer.name>2016-02-17 20:38:51 +0100
committerThomas Kriechbaumer <thomas@kriechbaumer.name>2016-02-17 21:10:48 +0100
commit09abd7eb9a6dc10bbe71ca87e9da07dbe9b3ba54 (patch)
tree42fbd9f6eacc02c3aa87215488783f60522227cd /README.rst
parent887ecf88967fe6caf8f8d5443e49b6bfcfbfcd0d (diff)
downloadmitmproxy-09abd7eb9a6dc10bbe71ca87e9da07dbe9b3ba54.tar.gz
mitmproxy-09abd7eb9a6dc10bbe71ca87e9da07dbe9b3ba54.tar.bz2
mitmproxy-09abd7eb9a6dc10bbe71ca87e9da07dbe9b3ba54.zip
add issue template
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index d6285700..d816a763 100644
--- a/README.rst
+++ b/README.rst
@@ -82,7 +82,7 @@ Please ensure that all patches are accompanied by matching changes in the test
suite. The project tries to maintain 100% test coverage.
-Docs
+Documentation
----
The mitmproxy documentation is build using Sphinx_, which is installed automatically if you set up a development
@@ -100,6 +100,30 @@ The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory
the documentation when a change is detected.
+Contributing
+----
+
+Thank you for your interest in contributing to mitmproxy!
+
+* Bug Reports
+
+Bug Reports are very welcome - please file them on the GitHub issue_tracker_.
+Please make sure to fill out the template and provide as much information as
+possible.
+
+* Feature Requests
+
+We're happy to hear what you'd like to see in mitmproxy. Please file feature
+requests on the GitHub issue_tracker_.
+
+* Patches
+
+We're always happy to accept patches. Please submit them in the form of pull
+requests to the this repository. If you're working on something cool, please do
+not hesitate and get in touch!
+
+
+
.. |mitmproxy_site| image:: https://shields.mitmproxy.org/api/https%3A%2F%2F-mitmproxy.org-blue.svg
:target: https://mitmproxy.org/
:alt: mitmproxy.org
@@ -143,3 +167,4 @@ the documentation when a change is detected.
.. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env
.. _Sphinx: http://sphinx-doc.org/
.. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild
+.. _issue_tracker: https://github.com/mitmproxy/mitmproxy/issues