diff options
Diffstat (limited to 'docs/contributing.md')
| -rw-r--r-- | docs/contributing.md | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 1b95496..00384c5 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -28,9 +28,22 @@ To run tests: ./run_tests.sh --pep8 # pep8 checks ./run_tests.sh --stats # print some code stats ./run_tests.sh --git # inception: run gitlint against itself -./run_tests.sh --lint # run pylint checks +./run_tests.sh --all # Run unit, integration, pep8 and gitlint checks +./run_tests.sh --lint # run pylint checks (only supported on python 2.7) ``` +The ```Vagrantfile``` comes with ```virtualenv```s for python 2.6, 2.7, 3.3, 3.4 and 3.5. +You can easily run tests against specific python environments by using the following commands *inside* of the Vagrant VM: +``` +./run_tests.sh --envs 26 # Run the unit tests against Python 2.6 +./run_tests.sh --envs 27,33 # Run the unit tests against Python 2.7 and Python 3.3 +./run_tests.sh --envs 27,33 --pep8 # Run pep8 checks against Python 2.7 and Python 3.3 (also works for ```--git```, ```--integration```, ```--pep8```, ```--stats``` and ```--lint```). +./run_tests.sh --envs all --all # Run all tests against all environments +./run_tests.sh --all-env --all # Idem: Run all tests against all environments +``` + +### Packaging ### + To see the package description in HTML format ``` pip install docutils |