Skip to content

Contributing

Thanks for wanting to contribute!

Development commands to know:

  • pnpm dev — start the library playground
  • pnpm play — start the playground (same as dev)
  • pnpm build — build the library
  • pnpm test — run unit tests
  • pnpm docs:dev — start the VitePress docs server

How to add a docs page:

  1. Add a markdown file under docs/ or docs/guide.
  2. Update docs/.vitepress/config.ts sidebar if needed.
  3. Run pnpm docs:dev to preview the page locally and ensure everything builds.
  4. Open a PR with your changes.

Guidelines:

  • Keep docs concise and example-driven
  • If adding code snippets to docs, verify they run in playground or tests
  • Add tests for any new features in test/ and update README / docs accordingly