CONTRIBUTING.md

Contributing

Getting Started

Install pnpm.

npm install -g pnpm

Download dependencies.

pnpm install

Install Helm.

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash

Developing

Watch changes of TypeScript files and rebuild automatically.

npm run watch

Delete built files.

npm run clean

Testing

Unit Tests

Run unit tests.

npm run test:unit

Integration Tests

Build TypeScript files.

npm run build

Run integration tests.

npm run test:integration

Browser Tests

Build TypeScript files.

npm run build

Run browser tests.

npm run test:browser

If the tests don't run:

• Puppeteer troubleshooting
• For WSL: puppeteer/puppeteer#1837

Linting

Lint TypeScript and JavaScript files.

npm run lint

Styleguides

Code Formatting

We use Prettier to format all the code.