If you are new to contributing to open source software this guide can help get you started.
If you want to contribute to pyerrors please fork pyerrors on Github, clone the repository
git clone http://github.com/my_username/pyerrors.git
and create your own branch for the feature or bug fix
cd pyerrors
git checkout -b feature/my_feature
After committing your changes please send a pull requests to the develop branch. A guide on how to create a pull request can be found here.
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 for docstrings. The startpage of the documentation is generated from the docstring of pyerrors/__init__.py.
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 code style which is checked by flake8.
For all pull requests tests are executed for the most recent python releases via
pytest -vv -Werror
pytest --nbmake examples/*.ipynb
flake8 --ignore=E501,W503 --exclude=__init__.py pyerrors
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
pytest --cov=pyerrors --cov-report html