Skip to content

Latest commit

 

History

History
70 lines (42 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

70 lines (42 loc) · 1.52 KB

Contributing

If you're thinking of contributing, thank you, and naturally, please be respectful 🙋🏻‍♂️

Issues

By opening an Issue, please describe the problem. If you can share a basic repro, it will be great.


Pull Requests

By opening a Pull Request, please describe the proposed solution and what it solves.


Developing

Environment

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.

Fixes

Where possible, provide an error test case that the fix covers.

Features

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.


Testing

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.


Lint

npm run lint

Also

npm run lint:fix