Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.35 KB
Raw

Contributing

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.

Project Structure

We use monorepo for multiple packages

└──packages
   ├──playground
   ├──preload
   ├──tsconfig
   ├──utils
   └──...

Pull Request

  • Checkout a topic branch from a base branch, e.g. master, 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.
  • Commit messages must follow the commit message convention. Commit messages are automatically validated before commit (by invoking Git Hooks via simple-git-hooks).
  • 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).