Contributing

September 19, 2022 · View on GitHub

Read about our Commitment to Open Source.

Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.

Developing

The development branch is main. This is the branch that all pull requests should be made against.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch: 
    git checkout -b MY_BRANCH_NAME
  3. Install pnpm: 
    npm install -g pnpm
  4. Install the dependencies with: 
    pnpm i
  5. Make changes and run tests using: 
    pnpm test

This repo is powered by Turborepo. Running commands such as test, build, and lint from the project root will utilize caching techniques to maximize developer productivity.

Testing

Each package has its own approach to testing. They can be executed independantly or as a group using turbo.

The easiest way to run the complete test suite is to run pnpm test from the root of this repository.

Linting

🏗 Coming Soon!