Skip to content

Commit

Permalink
add contributing section to README, remove autoenv
Browse files Browse the repository at this point in the history
  • Loading branch information
mhils committed Jan 29, 2017
1 parent a384dea commit f570c57
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
6 changes: 0 additions & 6 deletions .env

This file was deleted.

20 changes: 12 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,17 @@ Installation
The installation instructions are `here <http://docs.mitmproxy.org/en/stable/install.html>`__.
If you want to contribute changes, keep on reading.

Contributing
------------

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:

- **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.
- **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.

Setting Up a Development Environment
------------------------------------
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:

Expand All @@ -77,10 +85,6 @@ you can run them like any other command:
. venv3.5/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
-------

Expand Down Expand Up @@ -175,11 +179,11 @@ with the following command:

.. _`advanced installation`: http://docs.mitmproxy.org/en/latest/install.html#advanced-installation
.. _virtualenv: https://virtualenv.pypa.io/
.. _.env: https://github.com/mitmproxy/mitmproxy/blob/master/.env
.. _autoenv: https://github.com/kennethreitz/autoenv
.. _`py.test`: http://pytest.org/
.. _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
.. _forums: https://discourse.mitmproxy.org/
.. _`good first contributions`: https://github.com/mitmproxy/mitmproxy/issues?q=is%3Aissue+is%3Aopen+label%3Agood-first-contribution

0 comments on commit f570c57

Please sign in to comment.