diff options
Diffstat (limited to 'docs/dev')
| -rw-r--r-- | docs/dev/architecture.rst | 14 | ||||
| -rw-r--r-- | docs/dev/contributing.rst | 11 | ||||
| -rw-r--r-- | docs/dev/testing.rst | 47 |
3 files changed, 11 insertions, 61 deletions
diff --git a/docs/dev/architecture.rst b/docs/dev/architecture.rst deleted file mode 100644 index e7995141..00000000 --- a/docs/dev/architecture.rst +++ /dev/null @@ -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. diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst new file mode 100644 index 00000000..8e04c270 --- /dev/null +++ b/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
\ No newline at end of file diff --git a/docs/dev/testing.rst b/docs/dev/testing.rst deleted file mode 100644 index b86efce1..00000000 --- a/docs/dev/testing.rst +++ /dev/null @@ -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/ |