Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 1.76 KB
Raw

Contributing

Setup

This project uses pnpm to manage the dependencies, install if you haven't via

npm i -g pnpm

Clone repo to your local machine and install dependencies.

pnpm install

Project Structure

Monorepo

We use monorepo to manage multiple packages.

packages
  app/                    - main frontend app
  config/
    eslint-config/        - config to extend base eslint settings
    prettier-config/      - config to extend base prettier settings
    tsconfig/             - config to extend base tsconfig settings

Changesets

This project uses changesets to automate updating changelogs for the packages in config. To create a changeset for your packages you can run the following command in the corresponding package.

pnpm version-packages

Development

To build all the packages at once, run the following command at the root of the project.

pnpm build

To run a package locally, run the following command at the root of the project.

pnpm -F <name-of-package> dev

Testing

To test your packages, run the following command at the root of the project.

pnpm test

To test a specific package, run the following command at the root of the project.

pnpm -F <name-of-package> test

Code Style

You can setup prettier to automatically format code, or run the following command at the root of the project.

pnpm lint

The project has githooks via husky to ensure standardized code styles are met.