Skip to content

Contributing

Thank you for your interest in contributing to this project!

We welcome contributions of all kinds to this library, including non-code contributions.

Ways to contribute

Possible ways to contribute include: - Reporting bugs or suggesting features via GitHub Issues - Opening pull requests with improvements or fixes - Writing new examples or tutorials - Improving or expanding test coverage - Enhancing documentation, comments, or overall code readability

If you are unsure where to start, feel free to open an issue to discuss your ideas.

Code contributions

Code contributions follow the standard GitHub fork-and-pull-request workflow.

  1. Fork the repository to your own GitHub account.
  2. Create a new branch from main in your fork.
  3. Make your changes and commit them to your branch.
  4. Open a pull request to the main branch of this repository, describing what you changed and why.

Once a pull request is opened: - The maintainers will review the proposed changes. - Feedback or requested modifications may be discussed directly in the pull request. - The pull request may be updated by pushing additional commits to the same branch. - When the changes are ready, a maintainer will merge the pull request into the main branch.

Please note that changes are only incorporated into the codebase after being reviewed and merged by a maintainer. Small, focused contributions are preferred.

Code style

Please follow the existing style and structure in the codebase.