More info to contribute. (IDSIA#654)

* More info to contribute. * Added requirement * Update CONTRIBUTING.rst
muncok · Sep 22, 2019 · b09a070 · b09a070
1 parent c633f65
commit b09a070
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -99,17 +99,30 @@ local development.
 4. Create your development environment and install the pre-commit hooks::
 
     $ # Activate your environment
+    $ pip install -e .
     $ pip install -r dev-requirements.txt
     $ pre-commit install
 
+You can check that pre-commit works with::
+
+    $ pre-commit run --all-files
+
+if you get the error ``ModuleNotFoundError: No module named 'distutils.spawn'``,
+you should do the following::
+
+    $ sudo apt-get update
+    $ sudo apt-get install python3-distutils
+
+It should solve the problem with ``distutils.spawn``.
+
 Now you can make your changes locally.
 
 5. When you're done making changes, check that your changes pass style and unit
    tests, including testing other Python versions with tox::
 
     $ tox
 
-To get tox, just pip install it.
+To get tox, use ``pip install tox`` or ``pip install tox-conda``. If you have a conda distribution, you MUST use tox-conda.
 
 6. Commit your changes and push your branch to GitHub::