Contributing

Contributing Guide

We welcome pull requests for bug fixes and new features. Ensure your code passes the validation sequence (uv run ruff format ., uv run ruff check --fix ., uv run ty check <files>, uv run pytest), and use the following commit message format:

  • fix(element): description – bug fixes

  • feat(element): description – new features

  • minor(element): description – small improvements

  • chore(element): description – small improvements

  • doc(element): description – documentation changes

  • patch(element): description – incremental updates

Example:

fix(api): resolved an authentication issue

For larger changes, open an issue first to discuss your ideas. Documentation contributions are also appreciated. Update the docs/ sources and verify that sphinx-build completes without errors.