Contributing rules

Local development and testing

Build packages repo packages

Run npm run build in root, turbo should handle building the app,
If you encounter errors during build, check the code,
Build order should be tooling > core > cli,

Run npm i
Run npm run cli:init in the root of the project

Complete the configuration wizard

Run npm run cli in the root of the project

If you want to run the tool in a different directory, use npx [...path]/license-auditor/packages/dist/cli.js
Be mindful of user permissions (eg. chown on cli.js)

Testing

To run unit tests, run test:unit from the project root
To run E2E tests, run test:e2e from the project root