clarify how to setup a virtual env and run a small number of tests
MODIFY
Makefile
Makefile
@@ -43,6 +43,11 @@ clean:
test: requirements
tox
+.PHONY: test-quick
+test-quick: requirements
+ tox -e py36
+ tox -e py27
+
.PHONY: test-all
test-all: requirements
tox

MODIFY
docs/contributing.rst
docs/contributing.rst
@@ -17,6 +17,18 @@ If you wish to add a new feature or fix a bug:
:) Make sure to add yourself to ``CONTRIBUTORS.txt``.
+Setting up your development environment
+---------------------------------------
+
+It is recommended, and even enforced by the make file, that you use a
+`virtualenv
+<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_::
+
+ $ python3 -m venv venv3
+ $ source venv3/bin/activate
+ $ pip install -r dev-requirements.txt
+
+
Running the tests
-----------------
@@ -25,12 +37,17 @@ analysis while running test suite. Our ``Makefile`` handles much of this for
you as long as you're running it `inside of a virtualenv
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_::
- $ make test
+ $ make test-quick
[... magically installs dependencies and runs tests on your virtualenv]
Ran 182 tests in 1.633s
OK (SKIP=6)
+There is also a make target for running all of our tests and multiple python
+versions.
+
+ $ make test-all
+
Note that code coverage less than 100% is regarded as a failing run. Some
platform-specific tests are skipped unless run in that platform. To make sure
the code works in all of urllib3's supported platforms, you can run our ``tox``

clarify how to setup a virtual env and run a small number of tests (#1360)