Merge pull request #1964 from mhils/new-contribution-docs

New contribution docs

.env

@@ -1,6 +0,0 @@
-DIR="$( dirname "${BASH_SOURCE[0]}" )"
-ACTIVATE_DIR="$(if [ -f "$DIR/venv/bin/activate" ]; then echo 'bin'; else echo 'Scripts'; fi;)"
-if [ -z "$VIRTUAL_ENV" ] && [ -f "$DIR/venv/$ACTIVATE_DIR/activate" ]; then
-    echo "Activating mitmproxy virtualenv..."
-    source "$DIR/venv/$ACTIVATE_DIR/activate"
-fi

README.rst

@@ -37,7 +37,7 @@ each other solve problems, and come up with new ideas for the project.
 |mitmproxy_discourse|
 
 
-Join our developer chat on Slack if you would like to hack on mitmproxy itself.
+Join our developer chat on Slack if you would like to contribute to mitmproxy itself.
 
 |slack|
 
@@ -48,73 +48,64 @@ Installation
 The installation instructions are `here <http://docs.mitmproxy.org/en/stable/install.html>`__.
 If you want to contribute changes, keep on reading.
 
+Contributing
+------------
 
-Hacking
+As an open source project, mitmproxy welcomes contributions of all forms. If you would like to bring the project forward,
--------
+please consider contributing in the following areas:
 
-To get started hacking on mitmproxy, make sure you have Python_ 3.5.x or above with
+- **Maintenance:** We are *incredibly* thankful for individuals who are stepping up and helping with maintenance. This includes (but is not limited to) triaging issues, reviewing pull requests and picking up stale ones, helping out other users in our forums_, creating minimal, complete and verifiable examples or test cases for existing bug reports, updating documentation, or fixing minor bugs that have recently been reported.
-virtualenv_ installed (you can find installation instructions for virtualenv
+- **Code Contributions:** We actively mark issues that we consider are `good first contributions`_. If you intend to work on a larger contribution to the project, please come talk to us first.
-`here <http://virtualenv.readthedocs.org/en/latest/>`__). Then do the following:
+
+Development Setup
+-----------------
+
+To get started hacking on mitmproxy, please follow the `advanced installation`_ steps to install mitmproxy from source, but stop right before running ``pip3 install mitmproxy``. Instead, do the following:
 
 .. code-block:: text
 
-    sudo apt-get install python3-pip python3-dev libffi-dev libssl-dev libtiff5-dev libjpeg8-dev zlib1g-dev libwebp-dev
     git clone https://github.com/mitmproxy/mitmproxy.git
     cd mitmproxy
-    ./dev.sh  # powershell .\dev.ps1 on Windows
+    ./dev.sh  # "powershell .\dev.ps1" on Windows
 
 
-The *dev* script will create a virtualenv environment in a directory called
+The *dev* script will create a `virtualenv`_ environment in a directory called "venv"
-"venv3.5", and install all mandatory and optional dependencies into it. The
+and install all mandatory and optional dependencies into it. The primary
-primary mitmproxy components - mitmproxy and pathod - are installed as
+mitmproxy components - mitmproxy and pathod - are installed as
 "editable", so any changes to the source in the repository will be reflected
 live in the virtualenv.
 
-To confirm that you're up and running, activate the virtualenv, and run the
+The main executables for the project - ``mitmdump``, ``mitmproxy``,
-mitmproxy test suite:
-
-.. code-block:: text
-
-    . venv3.5/bin/activate  # venv\Scripts\activate on Windows
-    py.test
-
-Note that the main executables for the project - ``mitmdump``, ``mitmproxy``,
 ``mitmweb``, ``pathod``, and ``pathoc`` - are all created within the
 virtualenv. After activating the virtualenv, they will be on your $PATH, and
 you can run them like any other command:
 
 .. code-block:: text
 
+    . venv/bin/activate  # "venv\Scripts\activate" on Windows
     mitmdump --version
 
-For convenience, the project includes an autoenv_ file (`.env`_) that
-auto-activates the virtualenv when you cd into the mitmproxy directory.
-
-
 Testing
 -------
 
 If you've followed the procedure above, you already have all the development
-requirements installed, and you can simply run the test suite:
+requirements installed, and you can run the full test suite (including tests for code style and documentation) with tox_:
 
 .. code-block:: text
 
-    py.test
+    tox
+
+For speedier testing, we recommend you run `pytest`_ directly on individual test files or folders:
+
+.. code-block:: text
+
+    cd test/mitmproxy/addons
+    pytest --cov mitmproxy.addons.anticache --looponfail test_anticache.py
+
+As pytest does not check the code style, you probably want to run ``tox -e lint`` before committing your changes.
 
 Please ensure that all patches are accompanied by matching changes in the test
-suite. The project tries to maintain 100% test coverage.
+suite. The project tries to maintain 100% test coverage and enforces this strictly for some parts of the codebase.
-
-You can also use `tox` to run the full suite of tests, including a quick test
-to check documentation and code linting.
-
-The following tox environments are relevant for local testing:
-
-.. code-block:: text
-
-    tox -e py35  # runs all tests with Python 3.5
-    tox -e docs  # runs a does-it-compile check on the documentation
-    tox -e lint  # runs the linter for coding style checks
-
 
 Documentation
 -------------
@@ -133,8 +124,8 @@ installation, you can render the documentation like this:
 The last command invokes `sphinx-autobuild`_, which watches the Sphinx directory and rebuilds
 the documentation when a change is detected.
 
-Style
+Code Style
------
+----------
 
 Keeping to a consistent code style throughout the project makes it easier to
 contribute and collaborate. Please stick to the guidelines in
@@ -186,11 +177,13 @@ with the following command:
     :target: https://pypi.python.org/pypi/mitmproxy
     :alt: Supported Python versions
 
-.. _Python: https://www.python.org/
+.. _`advanced installation`: http://docs.mitmproxy.org/en/latest/install.html#advanced-installation
-.. _virtualenv: http://virtualenv.readthedocs.org/en/latest/
+.. _virtualenv: https://virtualenv.pypa.io/
-.. _autoenv: https://github.com/kennethreitz/autoenv
+.. _`pytest`: http://pytest.org/
-.. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env
+.. _tox: https://tox.readthedocs.io/
 .. _Sphinx: http://sphinx-doc.org/
 .. _sphinx-autobuild: https://pypi.python.org/pypi/sphinx-autobuild
 .. _PEP8: https://www.python.org/dev/peps/pep-0008
-.. _Google Style Guide: https://google.github.io/styleguide/pyguide.html
+.. _`Google Style Guide`: https://google.github.io/styleguide/pyguide.html
+.. _forums: https://discourse.mitmproxy.org/
+.. _`good first contributions`: https://github.com/mitmproxy/mitmproxy/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-contribution

dev.ps1

@@ -1,20 +1,19 @@
 $ErrorActionPreference = "Stop"
-$VENV = ".\venv"
 
 $pyver = python --version
 if($pyver -notmatch "3\.[5-9]") {
     Write-Warning "Unexpected Python version, expected Python 3.5 or above: $pyver"
 }
 
-python -m venv $VENV --copies
+python -m venv .\venv --copies
-& $VENV\Scripts\activate.ps1
+& .\venv\Scripts\activate.ps1
 
 python -m pip install --disable-pip-version-check -U pip
 cmd /c "pip install -r requirements.txt 2>&1"
 
 echo @"
 
-  * Created virtualenv environment in $VENV.
+  * Created virtualenv environment in .\venv.
   * Installed all dependencies into the virtualenv.
   * Activated virtualenv environment.
 

dev.sh

@@ -2,16 +2,14 @@
 set -e
 set -x
 
-PYVERSION=${1:-3.5}
+echo "Creating dev environment in ./venv..."
-VENV="venv$PYVERSION"
 
-echo "Creating dev environment in $VENV using Python $PYVERSION"
+python3 -m venv venv
-
+. venv/bin/activate
-python$PYVERSION -m venv "$VENV"
+pip3 install -U pip setuptools
-. "$VENV/bin/activate"
+pip3 install -r requirements.txt
-pip$PYVERSION install -U pip setuptools
-pip$PYVERSION install -r requirements.txt
 
 echo ""
-echo "* Virtualenv created in $VENV and all dependencies installed."
+echo "  * Created virtualenv environment in ./venv."
-echo "* You can now activate the $(python --version) virtualenv with this command: \`. $VENV/bin/activate\`"
+echo "  * Installed all dependencies into the virtualenv."
+echo "  * You can now activate the $(python3 --version) virtualenv with this command: \`. venv/bin/activate\`"

docs/dev/architecture.rst

@@ -1,14 +0,0 @@
-.. _architecture:
-
-Architecture
-============
-
-To give you a better understanding of how mitmproxy works, mitmproxy's
-high-level architecture is detailed in the following graphic:
-
-.. image:: ../schematics/architecture.png
-
-:download:`architecture.pdf <../schematics/architecture.pdf>`
-
-Please don't refrain from asking any further
-questions on the mailing list, the Slack channel or the GitHub issue tracker.

docs/dev/contributing.rst

@@ -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

docs/dev/testing.rst

@@ -1,47 +0,0 @@
-.. _testing:
-
-Testing
-=======
-
-All the mitmproxy projects strive to maintain 100% code coverage. In general,
-patches and pull requests will be declined unless they're accompanied by a
-suitable extension to the test suite.
-
-Our tests are written for the `py.test`_ or nose_ test frameworks.
-At the point where you send your pull request, a command like this:
-
->>> py.test --cov mitmproxy
-
-Should give output something like this:
-
-.. code-block:: none
-
-    > ---------- coverage: platform darwin, python 2.7.2-final-0 --
-    > Name                   Stmts   Miss  Cover   Missing
-    > ----------------------------------------------------
-    > mitmproxy/__init__         0      0   100%
-    > mitmproxy/app              4      0   100%
-    > mitmproxy/cmdline        100      0   100%
-    > mitmproxy/controller      69      0   100%
-    > mitmproxy/dump           150      0   100%
-    > mitmproxy/encoding        39      0   100%
-    > mitmproxy/flowfilter     201      0   100%
-    > mitmproxy/flow           891      0   100%
-    > mitmproxy/proxy          427      0   100%
-    > mitmproxy/script          27      0   100%
-    > mitmproxy/utils          133      0   100%
-    > mitmproxy/version          4      0   100%
-    > ----------------------------------------------------
-    > TOTAL                   2045      0   100%
-    > ----------------------------------------------------
-    > Ran 251 tests in 11.864s
-
-
-There are exceptions to the coverage requirement - for instance, much of the
-console interface code can't sensibly be unit tested. These portions are
-excluded from coverage analysis either in the **.coveragerc** file, or using
-**#pragma no-cover** directives. To keep our coverage analysis relevant, we use
-these measures as sparingly as possible.
-
-.. _nose: https://nose.readthedocs.org/en/latest/
-.. _py.test: https://pytest.org/

docs/index.rst

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

docs/install.rst

@@ -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/