|
| 1 | +# Contributing |
| 2 | + |
| 3 | +ReactiveScript is an early-stage language design. The spec is the product; |
| 4 | +the reference implementation in `ref/` exists to check it. |
| 5 | + |
| 6 | +## How claims are made |
| 7 | + |
| 8 | +Every behaviour claim is either a numbered rule (`E-n`, `H-n`, `AC-n`, …; |
| 9 | +see the README's *Rule IDs*) or a scenario under `scenarios/` |
| 10 | +(program → actions → frames → verdict). A change to the language comes |
| 11 | +with the rule it adds or amends and at least one scenario that shows it. |
| 12 | +`scenarios/TEMPLATE.md` is the starting point for a new one. |
| 13 | + |
| 14 | +Decisions recorded in the spec as *ruled* with a date are settled; please |
| 15 | +open an issue rather than a PR to revisit one. Decisions marked *taken by |
| 16 | +default* are still open to change. |
| 17 | + |
| 18 | +Semantics follow Solid 2.0 (`solidjs/solid@next`, pinned in |
| 19 | +`ref/SOLID_NEXT`). An open question in Solid's |
| 20 | +`packages/signals/docs/RULES-FUNDAMENTALS.md` is open here too. Where this |
| 21 | +spec diverges from Solid, the divergence is recorded as a `DV-n` in |
| 22 | +`spec/05-holds.md` or `spec/10-server.md`. |
| 23 | + |
| 24 | +## Running the suite |
| 25 | + |
| 26 | +Solid is built from its `next` branch at the pinned commit (needs pnpm and a |
| 27 | +Rust toolchain): |
| 28 | + |
| 29 | +```sh |
| 30 | +sh ref/scripts/solid-next.sh # checks out and builds ../solid-next |
| 31 | +cd ref && npm install |
| 32 | +npm test # interpreter over every scenario |
| 33 | +npm run oracle # the same scenarios lowered onto Solid |
| 34 | +npm run compiled # compiled modules |
| 35 | +npm run ssr # streamed SSR + hydration in Chromium |
| 36 | +npm run types # TSX projection checked by TypeScript |
| 37 | +``` |
| 38 | + |
| 39 | +`ref/README.md` describes each runner. Please run the suite before opening a |
| 40 | +pull request and note any scenario whose result changed. |
| 41 | + |
| 42 | +## Issues |
| 43 | + |
| 44 | +Bug reports and questions are welcome as GitHub issues. For a semantics |
| 45 | +question, a small `.rx` program and the frames you expected is the most |
| 46 | +useful form. |
0 commit comments