Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (32 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

45 lines (32 loc) · 1.22 KB

Contributing

We welcome all kinds of contributions! Feel free to create an issue when in doubt and take part in RFCs discussions.

Developing

First run pnpm install and pnpm build to install all deps and build a project. If you run into any problems while installing dependencies consider using the node version specified in .nvmrc file. Personally, I use fnm with shell integration to automatically pick up .nvmrc file and install the correct version but simple nvm also will do.

Project structure

We use monorepo with PNPM workspaces. The main package is placed under packages/earl, and this is where probably you will spend the most time.

Running tests

pnpm format
pnpm lint
pnpm typecheck
pnpm test

Introducing changes

We use a formatter and static analysis extensively but don't you worry! We have a magic script to run all checks locally and automatically fix all the auto-fixable problems:

pnpm test:fix

Watch mode

While inside packages/earl you might run pnpm build:watch to build project in watch mode.

pnpm build:watch:test will watch tests too. WARNING: this will create broken build (containing tests) in dist so you need to run pnpm build when done with watching.