OpenWF/SpaceNinjaServer
28
29
Fork 34
Code Issues 26 Pull Requests 6 Actions Packages Projects Releases Activity

chore: rework AGENTS.md into a more generic CONTRIBUTING.md (#2745)
Some checks failed
Build Docker image / docker-amd64 (push) Waiting to run
Details
Build Docker image / docker-arm64 (push) Waiting to run
Details
Build / build (push) Has been cancelled
Details

Browse Source 
This should be useful for humans as well :)

Reviewed-on: #2745
Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com>
Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com>
This commit is contained in:
Sainan 2025-09-03 22:45:02 -07:00 committed by Sainan
parent 648af9ae18
commit 18556cb2f5
2 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
AGENTS.md
View File

@ -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.

19
CONTRIBUTING.md Normal file
View File

@ -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.