lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-11-04 09:35:45 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: mainpage extended

Browse source
This commit is contained in:
Fabian Joswig 2021-11-16 11:45:16 +00:00
commit d97d76bf11
2 changed files with 16 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -9,13 +9,14 @@ and create your own branch
cd pyerrors
git checkout -b feature/my_feature
```
I find it convenient to install the package in editable mode in the local python environment
It can be convenient to install the package in editable mode in the local python environment when developing new features
```
pip install -e .
```
Please send any pull requests to the `develop` branch.
### Documentation
Please add docstrings to any new function, class or method you implement.
Please add docstrings to any new function, class or method you implement. The documentation is automatically generated from these docstrings. The startpage of the documentation is generated from the docstring of `pyerrors/__init__.py`.
### 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.
@ -23,7 +24,7 @@ When implementing a new feature or fixing a bug please add meaningful tests to t
### Continous integration
For all pull requests tests are executed for the most recent python releases via
```
pytest --cov=pyerrors -v
pytest --cov=pyerrors -vv
```
requiring `pytest`, `pytest-cov` and `pytest-benchmark`
and the linter `flake8` is executed with the command