CONTRIBUTING.md

Contributing Guide

Repo Setup

1. Run pnpm i in the root folder

2. Run pnpm run build in root folder.

Debugging

If you want to use break point and explore code execution you can use the "Run and debug" feature from vscode.

1. Add a debugger statement where you want to stop the code execution.

2. Click on the "Run and Debug" icon in the activity bar of the editor.

3. Click on the "Javascript Debug Terminal" button.

4. It will open a terminal and run pnpm run dev.

5. The execution will stop and you'll use the Debug toolbar to continue, step over, restart the process...

Running Tests

Each folder contains a __tests__ directory. The tests are run using vitest.

├── __tests__ <- integration & unit tests
│ ├── file11.unit.ts
│ └── file12.integration.ts
├── module2
│ ├── __tests__ <- integration & unit tests
│ │ └── file22.integration.ts
│ ├── file22.ts
│ └── file23.ts
└── index.ts

• pnpm test by default runs every test.