From edb046ec16241a6f1c72a9e101d4354dd439531e Mon Sep 17 00:00:00 2001 From: Alan Hamlett Date: Sun, 11 Mar 2018 18:01:20 -0700 Subject: [PATCH] improve contributing section --- README.rst | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index b1f8b41..5c16911 100644 --- a/README.rst +++ b/README.rst @@ -127,19 +127,25 @@ Useful Resources: Contributing ------------ -Before contributing a pull request, make sure tests pass:: - - virtualenv venv - . venv/bin/activate - pip install tox - tox - -The above will run tests on all Python versions available on your machine. -To just run tests on a single Python version:: +To install the dev environment:: virtualenv venv . venv/bin/activate pip install -r dev-requirements.txt + pip install tox + +Before contributing a pull request, make sure tests pass:: + + tox + +The above will run tests on all Python versions available on your machine. +To just run all tests with your current Python version:: + nosetests +To run only a single test method, specify the test file location, test class, +and test method. For example, to only run the Git project detection test:: + + nosetests tests.test_project:ProjectTestCase.test_git_project_detected + Many thanks to all `contributors `_!