If you're thinking of contributing, thank you, and naturally, please be respectful 🙋🏻♂️
By opening an Issue, please describe the problem. If you can share a basic repro, it will be great.
By opening a Pull Request, please describe the proposed solution and what it solves.
You will need these tools installed on your system:
Bun, Deno and Node.js versions are tested using Docker official images.
Fork this project, download your forked repository locally and create a new branch from main
.
Then run npm ci
to clean install the node modules.
Please, do not change the package-lock.json.
Where possible, provide an error test case that the fix covers.
It's better to discuss an API before actually start implementing it. You can open an Issue on Github, so we can discuss the API design implementation ideas.
Please ensure test cases to cover new features.
npm run test:node
bun run test:bun
deno task test:deno
Also, run npm run build
to compile and run E2E tests in the virtual browser.
npm run lint
Also
npm run lint:fix