Contribution

We welcome contributions from the community. For new features, we recommend first opening an issue to discuss the proposed contribution before opening a pull request.

Code Style

  • Follow the PEP 8 style guide for code.

  • Follow the Google Style Guide for docstrings.

  • Use the ruff linter and formatter to maintain code quality.

Workflow

  1. For new features, open an issue to discuss the proposed contribution.

  2. Fork the repository and implement the contribution.

  3. Add yourself to the CONTRIBUTORS.md file.

  4. Run pre-commit to format and lint code with:

pre-commit run --all-files

  1. Open a pull request to the main branch.