Contributing guidelines

We appreciate your interest in contributing to this project! Whether you found a bug, have a suggestion, or want to add new features, your input is welcome.

How to contribute

  1. Fork the repository

    Create your own copy of the repository on GitHub.

  2. Create a feature branch

    Use a descriptive name for your branch:

    git checkout -b fix/typo-in-readme

  3. Make changes

    Follow the coding style and ensure existing functionality is not broken. Add tests if relevant.

  4. Submit a pull request

    Push your branch and open a pull request on GitHub. Include a clear description of your changes.

  5. Wait for review

    We’ll review your PR and may request changes or offer suggestions.

Coding style

  • Follow PEP8 standards for Python code.

  • Use docstrings (PEP257) for public classes, functions, and modules.

  • Include type hints where appropriate.

  • Keep commits clean and descriptive.

Bug reports & feature requests

  • Use GitHub Issues to report bugs or suggest new features.

  • Include steps to reproduce, error messages, or use cases when possible.

Code of conduct

We strive to maintain a respectful and inclusive community. Please follow our code of conduct when interacting.

Thank you

Your contributions help improve the project and support the community. Thank you!