Welcome, and thanks for your interest in contributing! Please take a moment to review the following:
- Commits follow the "Conventional Commits" specification. This allows for changelogs to be generated automatically upon release.
- Code is formatted via Prettier
- JavaScript is written as TypeScript where possible.
- Fork the repo and clone to your machine.
- Create a new branch with your contribution.
- Install pnpm on your machine.
- In the repo, install dependencies via:
pnpm i
- Voilà, you're ready to go!
pnpm dev– runs jest, watching for file changespnpm build– production buildpnpm tsc– type checkspnpm test
A trade-off with using a personal repo is that permissions are fairly locked-down. In the mean-time releases will be made manually by the project owner.