diff options
| author | Maximilian Hils <git@maximilianhils.com> | 2015-02-05 17:52:08 +0100 |
|---|---|---|
| committer | Maximilian Hils <git@maximilianhils.com> | 2015-02-05 17:52:08 +0100 |
| commit | bed237503afa1fdaa9fe794f8c08af60f57a54ce (patch) | |
| tree | 6c45da5fa1633d51e1bcc1ad9d936953329c9593 /CONTRIBUTING.md | |
| parent | f215c3712ded010a20f73af78617a2d3c248b1bd (diff) | |
| download | mitmproxy-bed237503afa1fdaa9fe794f8c08af60f57a54ce.tar.gz mitmproxy-bed237503afa1fdaa9fe794f8c08af60f57a54ce.tar.bz2 mitmproxy-bed237503afa1fdaa9fe794f8c08af60f57a54ce.zip | |
Create CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..66851622 --- /dev/null +++ b/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.mkd). |