21 lines
563 B
Markdown
21 lines
563 B
Markdown
|
# Contribution Guide
|
||
|
|
|
||
|
|
## Setup
|
||
|
|
|
||
|
|
1. Install Node.js 20+.
|
||
|
|
2. Run `npm install`.
|
||
|
|
3. Run `npm run dev`.
|
||
|
|
4. Run `npm run docker-up` to verify the single-container path.
|
||
|
|
|
||
|
|
## Expectations
|
||
|
|
|
||
|
|
- Keep client gameplay code under `client/src/game`.
|
||
|
|
- Keep API and persistence code under `server/src`.
|
||
|
|
- Keep production assumptions aligned with the single-container deployment model.
|
||
|
|
- Prefer small milestone-focused changesets.
|
||
|
|
|
||
|
|
## CI Baseline
|
||
|
|
|
||
|
|
The repo includes a first-pass workflow that runs install, lint, test, build, and Docker build checks on pushes and pull requests.
|
||
|
|
|