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

docs: README and CONTRIBUTING updated.

Browse source
This commit is contained in:
Fabian Joswig 2023-03-10 14:25:17 +00:00
parent 3c942b380d
commit fe0f80b8c3
No known key found for this signature in database
2 changed files with 8 additions and 10 deletions

14
CONTRIBUTING.md
View file

@ -4,28 +4,24 @@ If you want to contribute to `pyerrors` please [fork](https://docs.github.com/en
```
git clone http://github.com/my_username/pyerrors.git --branch develop
```
and create your own branch
and create your own branch for the feature or bug fix
```
cd pyerrors
git checkout -b feature/my_feature
```
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. The documentation is automatically generated from these docstrings. The startpage of the documentation is generated from the docstring of `pyerrors/__init__.py`.
Please add docstrings to any new function, class or method you implement. The documentation is automatically generated from these docstrings. We follow the [numpydoc style](https://numpydoc.readthedocs.io/en/latest/format.html) for 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.
For all pull requests tests are executed for the most recent python releases via
```
pytest -vv --cov=pyerrors
pytest -vv --nbmake examples/*.ipynb
pytest
pytest --nbmake examples/*.ipynb
```
requiring `pytest`, `pytest-cov`, `pytest-benchmark`, `hypothesis' and `nbmake`. To install the test dependencies one can run `pip install pyerrors[test]`
requiring `pytest`, `pytest-cov`, `pytest-benchmark`, `hypothesis` and `nbmake`. To install the test dependencies one can run `pip install pyerrors[test]`
To get a coverage report in html run
```

4
README.md
View file

@ -4,7 +4,6 @@
- **Documentation:** https://fjosw.github.io/pyerrors/pyerrors.html
- **Examples:** https://github.com/fjosw/pyerrors/tree/develop/examples
- **Contributing:** https://github.com/fjosw/pyerrors/blob/develop/CONTRIBUTING.md
- **Bug reports:** https://github.com/fjosw/pyerrors/issues
## Installation
@ -17,3 +16,6 @@ to install the current `develop` version run
```bash
pip install git+https://github.com/fjosw/pyerrors.git@develop
```
## Contributing
We appreciate all contributions to the code, the documentation and the examples. If you want to get involved please have a look at our [contribution guideline](https://github.com/fjosw/pyerrors/blob/develop/CONTRIBUTING.md).