Contributing

Thanks for your interest in contributing to this project!

Here are a couple of guidelines to keep in mind before opening a Pull Request:

Please open a GitHub issue for discussion before submitting any significant changes to this API (including new features or functionality).
Please don't submit code that has been written by code-generation tools such as Copilot or Claude without first reviewing and testing the changeset.

Local development

To get started:

pnpm install

The documentation site is a great place to test pending changes. It runs on localhost port 3000 and can be started by running:

pnpm dev

To run unit tests locally:

pnpm test

To run end to end tests locally:

pnpm prerelease
pnpm e2e:install
pnpm dev:integrations & pnpm e2e:test

Before submitting, also make sure to update generated docs/examples:

pnpm compile
pnpm prettier
pnpm lint

Note

If you forget this step, CI will remind you!