-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |