mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-23 08:23:12 +09:00
Moving CONTRIBUTING.md to root
This commit is contained in:
6 files changed
+7
-7
No files matched your search
@@ -2,7 +2,7 @@
|
||||
|
||||
Clusterio manages distributed Factorio servers through a controller, hosts, and plugins.
|
||||
|
||||
Read [contributing](docs/devs/contributing.md) for the project map, setup, commands, debugging, tests, and code style.
|
||||
Read [contributing](contributing.md) for the project map, setup, commands, debugging, tests, and code style.
|
||||
For PR reviews, follow the [review guide](docs/devs/pr-review-guide.md), including its candidate ledger and final evidence audit.
|
||||
Use the detailed guides for the affected area:
|
||||
|
||||
@@ -20,7 +20,7 @@ Use the detailed guides for the affected area:
|
||||
Update affected documentation in the same change.
|
||||
- Follow nearby code and `.oxlintrc.json`: tabs, double quotes, semicolons, and `.js` extensions in relative TypeScript imports.
|
||||
Import shared public APIs through `@clusterio/lib` and check Node/browser exports when changing them.
|
||||
- Run commands from the root using the pinned pnpm version and the [documented Node requirements](docs/devs/contributing.md#supported-nodejs-and-factorio-versions).
|
||||
- Run commands from the root using the pinned pnpm version and the [documented Node requirements](contributing.md#supported-nodejs-and-factorio-versions).
|
||||
Install with `pnpm install --no-frozen-lockfile`; the lockfile is intentionally ignored.
|
||||
- `pnpm build` compiles TypeScript.
|
||||
It does not regenerate validators or production web bundles; use the appropriate package's `prepare` script.
|
||||
@@ -30,7 +30,7 @@ Use the detailed guides for the affected area:
|
||||
The harness needs Factorio, recreates `temp/test/`, and shares ports 8880/4443; do not run competing suites.
|
||||
- Report checks, failures, skips, and unverified behavior precisely.
|
||||
Documentation-only changes need path, command, and formatting checks.
|
||||
- Preview cleanup with `node scripts/clean.js --dry-run`; see the [cleanup scopes](docs/devs/contributing.md#cleaning-generated-and-runtime-files).
|
||||
- Preview cleanup with `node scripts/clean.js --dry-run`; see the [cleanup scopes](contributing.md#cleaning-generated-and-runtime-files).
|
||||
Runtime-data deletion and release publication require explicit authorization.
|
||||
Keep local configs, credentials, runtime data, and generated output out of commits.
|
||||
- Follow the [PR template](.github/pull_request_template.md), including `### Changelog` (`None.` when appropriate).
|
||||
File renamed without changes.
@@ -20,7 +20,7 @@ Plugin authors should also follow the [2.0 migration guide](docs/devs/plugin-mig
|
||||
### Ways to support me/the project:
|
||||
|
||||
* Contribute with code/documentation.
|
||||
See [Contributing](docs/devs/contributing.md) for how to make pull requests.
|
||||
See [Contributing](contributing.md) for how to make pull requests.
|
||||
Always nice to move the project forward.
|
||||
|
||||
* Support me monetarily on [patreon](https://www.patreon.com/danielv123) or paypal: danielv@live.no
|
||||
|
||||
@@ -55,4 +55,4 @@ See [writing plugins](writing-plugins.md#defining-link-messages) for a complete
|
||||
|
||||
When changing a wire message structure in [messages_core.ts](../../packages/lib/src/data/messages_core.ts), rebuild the packages with `pnpm -r run prepare` to regenerate the standalone validator.
|
||||
When changing a request or event class, keep serialization, allowed endpoints, permission checks, registration, and handlers consistent.
|
||||
The [contributor guide](contributing.md#checking-your-code-for-errors) explains how to run focused tests.
|
||||
The [contributor guide](../../contributing.md#checking-your-code-for-errors) explains how to run focused tests.
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
Review observable behavior across the whole PR, including callers, consumers, and lifecycle transitions.
|
||||
Reading every changed file and passing tests do not establish that those behaviors were covered.
|
||||
Use [contributing](contributing.md) for setup and validation commands.
|
||||
Use [contributing](../../contributing.md) for setup and validation commands.
|
||||
|
||||
|
||||
## Establish the scope
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
*
|
||||
* Listed messages are warned about instead of failing the test, and an entry
|
||||
* with connect skips starting the cluster. Entries for other versions are
|
||||
* ignored. See docs/devs/contributing.md for when to add an entry.
|
||||
* ignored. See contributing.md for when to add an entry.
|
||||
*/
|
||||
"use strict";
|
||||
import fs from "node:fs/promises";
|
||||
|
||||
Reference in new issue
Block a user