We are happy to accept contributions to this project. Please follow the instructions below.
All submissions will require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.
Our documentation is automatically generated using pdoc and deployed on the gh-pages
branch of this repository (see generate_doc.yml
).
You can modify the README's in the documentation by modifying the Markdown files in docs
.
You can modify the docstrings for individual classes and methods in the corresponding source files.
Create a pull request as usual with your modifications.