Contributing.md

Ways to contribute

1. Creating issues that you faced.
2. Choosing an issue to fix and raising a PR.
3. actualy using the product and providing feedback.

Guidelines

1. make sure the issue is not duplicate of already created issue
2. choose existing issue to create a PR, dont create PR without an issue.
3. PRs should adress one issue at a time.

Local setup

1. make sure you have pnpm and nodejs in your local
2. fork the repo.
3. clone the repo.
4. run pnpm i && pnpm build

Steps

1. Make changes to your local copy.
2. add/fix the tests.
3. add/fix readme.
4. run pnpm run precommit
5. add changesets by using pnpm changeset
6. push to your forked repo.
7. raise PR.