diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index 7a1b6292..00000000 --- a/AGENTS.md +++ /dev/null @@ -1,17 +0,0 @@ -## In General - -### Prerequisites - -Use `npm i` or `npm ci` to install all dependencies. - -### Testing - -Use `npm run verify` to verify that your changes pass TypeScript's checks. - -### Formatting - -Use `npm run prettier` to ensure your formatting matches the expected format. Failing to do so will cause CI failure. - -## 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 produce non-English strings; we want them to be translated by humans who can understand the full context. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7510cd92 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +## 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 `npm run 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 fix` to fix formatting issues as well as be informed of any unfixable issues. Avoid introducing new warnings. + +## 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.