Merge pull request #958 from Kriechi/issue-template

add issue template

CONTRIBUTING.md

@@ -1,39 +0,0 @@
-# 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](https://github.com/mitmproxy/mitmproxy/issues). 
-You can use the following template to structure your report:
-
-```
-##### Steps to reproduce the problem:
-1.
-2.
-3.
-
-##### What is the expected behavior?
-
-
-##### What went wrong?
-
-
-##### Any other comments?
-
-
----
-mitmproxy version:
-Operating System:
-```
-
-# Feature Requests
-
-We're happy to hear what you'd like to see in mitmproxy. Please file feature requests on the GitHub [issue tracker](https://github.com/mitmproxy/mitmproxy/issues). 
-
-# Patches
-
-We're always happy to accept patches. Please submit them in the form of pull requests to the main [mitmproxy repository](https://github.com/mitmproxy/mitmproxy/).  
-If you're working on something cool, please do not hesistate and get in touch!
-
-Instructions for setting up a development environment can be found in the [README](README.rst).  

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

issue_template.md

@@ -0,0 +1,28 @@
+##### Steps to reproduce the problem:
+1. Launch mitmproxy
+2. Press X
+3. Click Y
+
+##### What is the expected behavior?
+
+It should display Z.
+
+##### What went wrong?
+
+It crashed with this error/trace: ...
+
+##### Any other comments?
+
+None.
+
+---
+
+mitmproxy version: (e.g.: 0.16, git commit hash)
+
+mitmproxy installed from: (e.g.: pip, binary package, source)
+
+Operating System: (e.g.: Windows, OSX, Linux, with specific version)
+
+OpenSSL version: (e.g.: 1.0.2f, run `openssl version` in your shell)
+
+pyOpenSSL version: (e.g.: 0.15.1, run `import OpenSSL; print(OpenSSL.__version__)` in Python)