diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/contributing.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index f0d2d30..e58378c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -34,7 +34,8 @@ and it's likely that your PR will be merged and released a lot sooner. Thanks! ## Development -There is a Vagrantfile in this repository that can be used for development. +There is a Vagrantfile (Ubuntu) in this repository that can be used for development. +It comes pre-installed with all Python versions that gitlint supports. ```sh vagrant up vagrant ssh @@ -51,7 +52,7 @@ python setup.py develop To run tests: ```sh ./run_tests.sh # run unit tests and print test coverage -./run_test.sh gitlint/tests/test_body_rules.py::BodyRuleTests::test_body_missing # run a single test +./run_tests.sh gitlint/tests/rules/test_body_rules.py::BodyRuleTests::test_body_missing # run a single test ./run_tests.sh --no-coverage # run unit tests without test coverage ./run_tests.sh --collect-only --no-coverage # Only collect, don't run unit tests ./run_tests.sh --integration # Run integration tests (requires that you have gitlint installed) @@ -63,12 +64,12 @@ To run tests: ./run_tests.sh --all # Run unit, integration, pep8 and gitlint checks ``` -The `Vagrantfile` comes with `virtualenv`s for python 2.7, 3.5, 3.6, 3.7, 3.8, 3.9 and pypy2. +The `Vagrantfile` comes with `virtualenv`s for python 3.6, 3.7, 3.8, 3.9 and pypy3.6. You can easily run tests against specific python environments by using the following commands *inside* of the Vagrant VM: ```sh -./run_tests.sh --envs 27 # Run the unit tests against Python 2.7 -./run_tests.sh --envs 27,37,pypy2 # Run the unit tests against Python 2.7, Python 3.7 and Pypy2 -./run_tests.sh --envs 27,37 --pep8 # Run pep8 checks against Python 2.7 and Python 3.7 (also works for --git, --integration, --pep8, --stats and --lint. +./run_tests.sh --envs 36 # Run the unit tests against Python 3.6 +./run_tests.sh --envs 36,37,pypy36 # Run the unit tests against Python 3.6, Python 3.7 and Pypy3.6 +./run_tests.sh --envs 36,37 --pep8 # Run pep8 checks against Python 3.6 and Python 3.7 (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 ``` |