Contributing

July 3, 2022 ยท View on GitHub

Thanks for being interested in contributing to this project!

Repo Setup

Clone this repo to your local machine and install the dependencies.

pnpm install

NOTE: The package manager used to install and link dependencies must be pnpm.

Pull Request

  • Checkout a topic branch from a base branch, e.g. fix-bug, and merge back against that branch.
  • It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
  • To check that your contributions match the project coding style make sure pnpm lint && pnpm typecheck passes. To build project run: pnpm build.
  • Commit messages must follow the commit message convention. Commit messages are automatically validated before commit (by invoking Git Hooks via simple-git-hooks).
  • Commit messages preferably in English.
  • No need to worry about code style as long as you have installed the dev dependencies - modified files are automatically formatted with Prettier on commit (by invoking Git Hooks via simple-git-hooks).