# Contribution

Please read [Auth0's contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md).

## Environment setup

- Make sure you have node and pnpm installed
- Run `pnpm install` to install dependencies
- Follow the local development steps below to get started

## Local development

- `pnpm install`: install dependencies
- `pnpm run build`: Build the project
- `pnpm run build:watch`: Watch for changes and rebuild the project
- `pnpm test:unit`: Run the unit tests
- `pnpm run test:coverage`: Run unit test coverage
- `pnpm run test:e2e`: Run the E2E tests and watch for changes (you will need to populate the `TEST_USER_PASSWORD` env var)

## Generate docs

- `pnpm run docs` – Generates the API documentation 
- `npx http-server docs` – Serves the documentation locally