Update contribution instructions.

Also provide shortcuts in a Makefile.
This commit is contained in:
Aymeric Augustin
2019-12-22 21:31:12 +01:00
parent c3783399db
commit 70373a5f7c
4 changed files with 137 additions and 44 deletions

View File

@@ -1,5 +1,24 @@
.PHONY: style
.PHONY: quality style test test-examples
# Check that source code meets quality standards
quality:
black --check --line-length 119 examples templates tests src utils
isort --check-only --recursive examples templates tests src utils
flake8 examples templates tests src utils
# Format source code automatically
style:
black --line-length 119 examples templates tests src utils
isort --recursive examples templates tests src utils
# Run tests for the library
test:
python -m pytest -n auto --dist=loadfile -s -v ./tests/
# Run tests for examples
test-examples:
python -m pytest -n auto --dist=loadfile -s -v ./examples/