Contribute

We are really open to your thoughts and feedback!

Bug reporting

Please report any bug that you may find to the issues section.

Requesting a Feature

If you find a new feature could be useful for the community, please try to add it in the issues section with a clear description.

Submitting a Pull Request

  • Start by forking the develop branch.

  • Add your code to the project!

  • Test your code running the tests using make test. This script checks the code format and linting (ruff), types (pyright) and unittests (pytest).

  • Running make test will generate three HTML files which are placed within a created folder reports.

  • Once your code successfully passed the tests, you can submit a pull request and wait for its approval

Approval of pull request

A pull request will be accepted if:

  • Adds new functionalities of interest.

  • Does not decrease the overall project code coverage.

Note

You will need to add tests for your code. For this, you can check the current tests.

Adding new examples

To add new examples, consider editing yourself a rst file in docs/source/ directory in the repository. For questions or doubts, use GitHub discussions.

API discussions

Consider posting your questions or suggestions on GitHub discussions or GitHub issues.

Doubts?

Feel free to contact me :)