34 lines (22 loc) · 828 Bytes

Contribution

Please read Auth0's contribution guidelines.

Environment setup

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

Local development

npm install: install dependencies
npm run test: run unit tests for all packages
npm run build: compile all packages
npm run clean: remove compiled artifacts for all packages
npm run lint: run linter for all packages
npm run docs: generate API docs

Testing

Adding tests

Every change should be accompanied by a test.

Running tests

Run unit tests before opening a PR:

npm run test

Also include any information about essential manual tests.