diff options
Diffstat (limited to 'mitmproxy/CONTRIBUTING.md')
| -rw-r--r-- | mitmproxy/CONTRIBUTING.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/mitmproxy/CONTRIBUTING.md b/mitmproxy/CONTRIBUTING.md new file mode 100644 index 00000000..ae948d73 --- /dev/null +++ b/mitmproxy/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# 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). |