CONTRIBUTING.md · XFE Studio Git

In General

Prerequisites

Use npm i or npm ci to install all dependencies, including dev dependencies.

Development Process

Auto reloading is supported for server and WebUI development. Simply use npm run dev or bun dev:bun to start the server and edit away.

Testing

Before submitting a PR:

Use npm run verify to verify that the code is type-safe.
Use npm run lint and npm run fix to ensure your code meets our standards.

Repeat these steps if you make any changes.

WebUI Specific

The translation system is designed around additions being made to static/webui/translations/en.js. They are copied over for translation via npm run update-translations. DO NOT provide translations generated by AI or other automated tools.

## In General ### Prerequisites Use `npm i` or `npm ci` to install all dependencies, including dev dependencies. ### Development Process Auto reloading is supported for server and WebUI development. Simply use `npm run dev` or `bun dev:bun` to start the server and edit away. ### Testing Before submitting a PR: - Use `npm run verify` to verify that the code is type-safe. - Use `npm run lint` and `npm run fix` to ensure your code meets our standards. Repeat these steps if you make any changes. ## WebUI Specific The translation system is designed around additions being made to `static/webui/translations/en.js`. They are copied over for translation via `npm run update-translations`. DO NOT provide translations generated by AI or other automated tools.