From d4a7ee23d5f95998858d052dbbac37917a3bc92f Mon Sep 17 00:00:00 2001 From: Daniel Jones Date: Wed, 7 Oct 2020 15:11:21 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9ec753..91bfdda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,41 @@ # Contributing -## Testing +## Code style + +To run a style check with flake8: -To run flake8 PEP8 style checker: ``` flake8 isobar ``` +## Testing + To run unit tests: + ``` python3 setup.py test ``` -To generate a coverage report: +To generate a unit test coverage report: + ``` pip3 install pytest-cov pytest --cov=isobar tests ``` +## Documentation + To regenerate the per-class pattern docs for the README: + ``` aux/scripts/generate-docs.py ``` + +## Distribution + +To push to PyPi: + +* increment version in `setup.py` +* `git tag vx.y.z`, `git push --tags`, and create GitHub release +* `python3 setup.py sdist` +* `twine upload dist/isobar-x.y.z.tar.gz`