From 7a88f6f4864deee79f850ae0ebb75d1c32d437a4 Mon Sep 17 00:00:00 2001 From: Sainan <63328889+Sainan@users.noreply.github.com> Date: Mon, 23 Jun 2025 14:56:08 -0700 Subject: [PATCH] chore: create AGENTS.md (#2262) Reviewed-on: https://onlyg.it/OpenWF/SpaceNinjaServer/pulls/2262 Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com> Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com> --- AGENTS.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..7a1b6292 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,17 @@ +## 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.