CONTRIBUTING.md

August 26, 2026 ยท View on GitHub

Make sure that what you trying to fix really a bug, or if adding feature that is good way to solve your task.

  1. Fork the repo and install stuff:
  • This repo uses pnpm. Run pnpm run setup in the root folder (it will install all deps for the workspace and do other required steps)
  • Run pnpm run demo for run the demo project in watch mode

  1. Write code! Add some feature or fix bug.

  2. Check that all tests passed(unit and e2e) and add tests for your code. You can run unit tests with pnpm run test:unit and Playwright e2e tests with pnpm run test:e2e

  3. Update readme and example (if needed)

  4. Make commit and Pull Request, review, approval and merge.