lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-03-15 06:40:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: Contributing guidelines clarified.

Browse source
This commit is contained in:
Fabian Joswig 2023-07-10 16:11:25 +01:00
parent c47e1ccac7
commit bf25ecf2ee
No known key found for this signature in database
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTING.md
View file

@ -19,19 +19,17 @@ Please add docstrings to any new function, class or method you implement. The do
### Tests ### Tests
When implementing a new feature or fixing a bug please add meaningful tests to the files in the `tests` directory which cover the new code. When implementing a new feature or fixing a bug please add meaningful tests to the files in the `tests` directory which cover the new code.
We follow the [PEP8](https://peps.python.org/pep-0008/) code style which is checked by `flake8`.
For all pull requests tests are executed for the most recent python releases via For all pull requests tests are executed for the most recent python releases via
``` ```
pytest -vv -Werror pytest -vv -Werror
pytest --nbmake examples/*.ipynb pytest --nbmake examples/*.ipynb
flake8 --ignore=E501,W503 --exclude=__init__.py pyerrors
``` ```
requiring `pytest`, `pytest-cov`, `pytest-benchmark`, `hypothesis` and `nbmake`. To install the test dependencies one can run `pip install pyerrors[test]` The tests require `pytest`, `pytest-cov`, `pytest-benchmark`, `hypothesis`, `nbmake` and `flake8`. To install the test dependencies one can run `pip install pyerrors[test]`.
Please make sure that all tests pass for a new pull requests.
To get a coverage report in html run To get a coverage report in html run
``` ```
pytest --cov=pyerrors --cov-report html pytest --cov=pyerrors --cov-report html
``` ```
The linter `flake8` is executed with the command
```
flake8 --ignore=E501,W503 --exclude=__init__.py pyerrors
```
Please make sure that all tests pass for a new pull requests.