OpenWF/SpaceNinjaServer
28
29
Fork 34
Code Issues 26 Pull Requests 6 Actions Packages Projects Releases Activity
SpaceNinjaServer/CONTRIBUTING.md
Sainan 18556cb2f5
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
chore: rework AGENTS.md into a more generic CONTRIBUTING.md (#2745) 
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>
2025-09-03 22:45:02 -07:00

770 B
Raw Permalink Blame History

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.