CONTRIBUTION.md: add tox, and details about pre-commit, fix issues

csernazs · csernazs · commit e83a74cb50f6 · 2023-03-07T21:20:37.000+01:00
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -20,8 +20,9 @@ https://pytest-httpserver.readthedocs.io/en/latest/background.html
 
 There are a few rules you are kindly asked to accept:
 
-* Coding style is checked by `pre-commit`. You can run `make precommit` before proceeding
-  with the PR.
+* Coding style is checked by `pre-commit`. You can run `make precommit` before
+  proceeding with the PR. To install the pre-commit hooks to your git (so it
+  will be run for each commit), run `pre-commit install`.
 
 * Tests should be written for the new code. If there's a complex logic
   implemented, it should be tested on different valid and invalid inputs and
@@ -41,11 +42,15 @@ There are a few rules you are kindly asked to accept:
 * You can let your IDE of your choice to use the `.venv/bin/python` interpreter,
   so it will know all the dependencies.
 
-* running tests on the localhost can be done by issuing `make quick-test`. It is
-  "quick" because it tests the software with only one interpreter. Note that the
+* running tests on the localhost can be done by issuing `make test`. Note that the
   library can be used by many supported interpreters and unless it is absolutely
   required, we don't want to drop support.
 
+* running tests on multiple versions of interpreter locally can be done by
+  `tox`. Keep in mind that the CI job uses github actions with caching for
+  effective use, and `tox` is provided for the developers only.
+
+
 ## More technical details
 
 * Release notes must be written for significant changes. This is done by
