How to contribute to pentapy

We are happy about all contributions! 👍

Did you find a bug?

Ensure that the bug was not already reported under GitHub issues
If the bug wasn't already reported, open a new issue with a clear description of the problem and if possible with a minimal working example.
please add the version number to the issue:

import pentapy
print(pentapy.__version__)

Open a new issue with your idea or suggestion and we'd love to discuss about it.

Fork the repo on GitHub.
Commit your stuff
Add yourself to AUTHORS.md (if you want to).
We use the black code format, please use the script black . after you have written your code.
Add some tests of your extension to tests/test_pentapy.py
- we use unittest for our test suite, have a look at their documentation
- to run the tests you can use pytest with running pytest -v tests/ from the source directory
Push to your fork and submit a pull request.