Develop and contribute
Getting started
Read README.md or README.fr.md, then CONTRIBUTING.md / CONTRIBUTING.fr.md. Install Node 24.22.3; for Windows binaries, Rust 1.88.0, MSVC and WebView2. The Node/Lua harness runs without WoW on Windows and Linux.
npm ci --ignore-scripts
npm run verify
npm --prefix documentation ci --ignore-scripts
npm --prefix documentation run verifyCreate a focused branch such as docs/historical-prices or fix/return-variants. Commits describe one coherent change and its reason. PRs explain the concrete problem, resulting behavior, executed validation and remaining limits.
Where changes belong
| Need | Starting point |
|---|---|
| Calculations / decisions | engine/lib |
| Desktop interface | engine/public |
| Native shell | source/src-tauri |
| Game / TSM | addon/DonjonsEtPognons |
| Harness / packaging | scripts and tests |
| Human reference | documentation/content and content/en |
Reproduce financial defects with a synthetic fixture before fixing them. Cover relevant boundaries: identity, age, commission, quantity, reserve and rereads. A test that merely repeats a formula is not independent evidence.
Before proposing
Run relevant checks, update both languages and the changelog, run git diff --check and inspect for private files. Every new shareable source belongs in release-files.json; do not broaden exports to the entire directory. Dependencies remain pinned with lockfiles. Structural decisions need an ADR.
The code retains its existing MIT license. Private repository visibility does not change that license. Third-party dependencies and assets retain their own terms; inspect LICENSE and docs/ASSET-NOTICES.txt before redistribution.
