Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ideoforms committed Oct 7, 2020
1 parent 64eebfa commit d4a7ee2
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
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`

0 comments on commit d4a7ee2

Please sign in to comment.