返回提交历史
Deleted
AGENTS.md
+0
-17
Added
CONTRIBUTING.md
+19
-0
XFEstudio/XFESpaceNinjaServer
chore: rework AGENTS.md into a more generic CONTRIBUTING.md (#2745)
This should be useful for humans as well :) Reviewed-on: https://onlyg.it/OpenWF/SpaceNinjaServer/pulls/2745 Co-authored-by: Sainan <63328889+Sainan@users.noreply.github.com> Co-committed-by: Sainan <63328889+Sainan@users.noreply.github.com>
18556cb2
代码差异
2 个文件
+19
-17
@@ -1,17 +0,0 @@
1
## In General
2
3
### Prerequisites
4
5
Use `npm i` or `npm ci` to install all dependencies.
6
7
### Testing
8
9
Use `npm run verify` to verify that your changes pass TypeScript's checks.
10
11
### Formatting
12
13
Use `npm run prettier` to ensure your formatting matches the expected format. Failing to do so will cause CI failure.
14
15
## WebUI Specific
16
17
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.
@@ -0,0 +1,19 @@
1
## In General
2
3
### Prerequisites
4
5
Use `npm i` or `npm ci` to install all dependencies, including dev dependencies.
6
7
## Development Process
8
9
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.
10
11
### Testing
12
13
Before submitting a PR:
14
- Use `npm run verify` to verify that the code is type-safe.
15
- Use `npm run fix` to fix formatting issues as well as be informed of any unfixable issues. Avoid introducing new warnings.
16
17
## WebUI Specific
18
19
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.