Contributing

Guidelines

Contributing to this project should be as easy and transparent as possible, whether it's:

• Reporting a bug
• Discussing the current state of the code
• Submitting a fix
• Proposing new features

Getting started

Set up the project with ./scripts/setup.sh.

GitHub is used for everything

GitHub is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

1. Fork the repo and create your branch from develop
2. If you've changed something, update the documentation.
3. Add an entry under ## [Unreleased] in CHANGELOG.md for every user-visible change.
4. Make sure your code lints with ./scripts/lint.sh.
5. Test your contribution. 100% test coverage is required.
6. Issue that pull request!

Report bugs using Github's issues

GitHub issues are used to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

• A quick summary and/or background
• Steps to reproduce
  • Be specific!
  • Give sample code if you can
• What you expected would happen
• What actually happens
• Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Use ruff for formatting and linting and ty for type checking. Run all linters at once with:

./scripts/lint.sh

See CLAUDE.md for the project rules.

AI assistant

The project only uses Claude Code as AI assistant. Its rules are in CLAUDE.md, tests/CLAUDE.md, website/CLAUDE.md and the skills in .claude/skills/.

Build the documentation

The documentation is a Docusaurus website in website/ and needs Node.js. The API reference is generated from the docstrings:

./scripts/docs.sh        # build
./scripts/docs.sh start  # live reload

Test your code modification

To test the code we use pytest:

uv run pytest

If a test changes the recorded requests, regenerate the snapshots and review the diff:

uv run pytest -n0 --snapshot-update

License

By contributing, you agree that your contributions will be licensed under its Apache License.