Open
Description
Context
When running into a 'Code style' check error like the one below, it's not immediately clear from the README how to resolve it:
Run npm run format:check --prefix compiler
> [email protected] format:check
> prettier --config .prettierrc.json --loglevel warn --check ../specification/
[warn] ../specification/inference/_types/Services.ts
[warn] ../specification/inference/_types/TaskType.ts
[warn] Code style issues found in the above file(s). Forgot to run Prettier?
Error: Process completed with exit code 1.
While the Style Guide (linked at the top of the README) does include the necessary instructions, this information can be difficult to find—especially for new contributors who naturally look to the README first for setup and troubleshooting help.
Proposal:
Add a short note/FAQ to the README to clarify that the Style Guide also includes instructions for handling code formatting and linting issues.