vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-01 18:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add contributing section that redirects to README

Browse source
This commit is contained in:
Maximilian Hils 2017-01-29 22:10:37 +01:00
parent e10fb22f9c
commit edb96f69f5
3 changed files with 15 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/dev/contributing.rst Normal file
View file

@ -0,0 +1,11 @@
.. _contributing:
Contributing
============
As an open source project, **mitmproxy** welcomes contributions of all forms.
Please head over to the README_ to get started! 😃
.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst

3
docs/index.rst
View file

@ -78,8 +78,9 @@
.. toctree::
:hidden:
:caption: Hacking
:caption: Development
dev/contributing
dev/sslkeylogfile
.. Indices and tables

4
docs/install.rst
View file

@ -139,11 +139,11 @@ Latest Development Version
If you would like to install mitmproxy directly from the master branch on GitHub
or would like to get set up to contribute to the project, install the
dependencies as you would for a regular installation from source. Then see the
Hacking_ section of the README on GitHub. You can check your system information
project's README_ on GitHub. You can check your system information
by running: ``mitmproxy --version``
.. _Hacking: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst#hacking
.. _README: https://github.com/mitmproxy/mitmproxy/blob/master/README.rst
.. _releases: https://github.com/mitmproxy/mitmproxy/releases
.. _mitmproxy.org: https://mitmproxy.org/
.. _`Python website`: https://www.python.org/downloads/windows/