Merge pull request #210 from ericdill/contributing

Add instructions for installing the pre-commit hooks

.gitignore

@@ -10,5 +10,9 @@ dist/
 venv/
 test_install*.yml
 test_install*.lock
+tests/**/*.lock
+tests/**/*.yml
+tests/**/*.bak
 site/
-filelock
+filelock
+.coverage

CONTRIBUTING.md

@@ -3,10 +3,18 @@
 
 For the most up-to-date instructions see the github actions [test.yml workflow](./github/workflows.test.yml)
 
-1. Install conda and mamba
-1. mamba create -n test pip pytest-cov pytest-xdist pip
-1. conda activate test
-1. python -m pip install -r requirements.txt
-1. python -m pip install -r requirements-dev.txt
-1. pip install -e . --no-deps --force-reinstall
-1. pytest -n auto -vrsx --cov=conda_lock tests
+1. Ensure conda and mamba are installed. Install [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) if you're otherwise not sure which one to pick.
+2. `mamba create -n conda-lock-dev pip pytest-cov pytest-xdist pip`
+3. `conda activate conda-lock-dev`
+4. `python -m pip install -r requirements.txt`
+5. `python -m pip install -r requirements-dev.txt`
+6. `pip install -e . --no-deps --force-reinstall`
+
+Run the tests to ensure that everything is running correctly. Due to the nature of this project, it hits remote webservers regularly so some tests occasionally fail. This is a normal part of conda-lock development. If you're not sure if your env is borked or the remote webserver is just being flaky, run the tests again. If you're still not sure you can open an issue about.
+
+7. `pytest`
+
+Whilst not strictly necessary; the CI run using github actions will run pre-commit in order to reduce development friction you may want to install the pre-commit hooks:
+
+8. `pre-commit install`
+

setup.cfg

@@ -1,9 +1,14 @@
 [tool:pytest]
+addopts = -vrsx -n auto
 flake8-max-line-length = 105
 flake8-ignore =
     docs/* ALL
     conda_lock/_version.py ALL
 
+[coverage:run]
+omit = conda_lock/vendor/*
+source = conda_lock/*
+
 [metadata]
 name = conda_lock
 description = Lockfiles for conda