mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-15 14:50:25 +01:00
docs: CONTRIBUTING extended
This commit is contained in:
parent
370cd34e0f
commit
3324b0aa07
1 changed files with 5 additions and 4 deletions
|
@ -20,14 +20,15 @@ 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.
|
||||||
|
|
||||||
### Continous integration
|
|
||||||
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 --cov=pyerrors -vv
|
pytest --cov=pyerrors -vv
|
||||||
```
|
```
|
||||||
requiring `pytest`, `pytest-cov` and `pytest-benchmark`
|
requiring `pytest`, `pytest-cov` and `pytest-benchmark`. To get a coverage report in html run
|
||||||
and the linter `flake8` is executed with the command
|
```
|
||||||
|
pytest --cov=pyerrors --cov-report html
|
||||||
|
```
|
||||||
|
The linter `flake8` is executed with the command
|
||||||
```
|
```
|
||||||
flake8 --ignore=E501,E722 --exclude=__init__.py pyerrors
|
flake8 --ignore=E501,E722 --exclude=__init__.py pyerrors
|
||||||
```
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue