Skip to content

Commit a2cbdf3

Browse files
authored
Merge pull request #8 from ryansolid/claude/project-thread-mf2az4
Prepare repo for going public: LICENSE, CONTRIBUTING, README status
2 parents 49e3f78 + 5ba327c commit a2cbdf3

3 files changed

Lines changed: 75 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
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.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Ryan Carniato
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ semantics: equations by default, writes confined to imperative scope, ownership
55
and async (pending, holds, lanes) as things the compiler checks rather than the
66
runtime warns about.
77

8+
> **Status:** early design work. The spec, its scenarios and the reference
9+
> implementation change often, and nothing here is released. See
10+
> [CONTRIBUTING.md](CONTRIBUTING.md) to run the suite or propose a change.
11+
812
This repository is the **spec** and its **reference implementation**. The
913
production compiler is a separate Rust crate over Solid's own
1014
`solidjs-compiler` (`spec/11-compiler.md`): ReactiveScript parses, checks
@@ -88,3 +92,7 @@ Scenario IDs: `S-<area>-n` for the areas above (`S-core`, `S-region`,
8892
- *Superset of `.tsx`, no SFCs* — superseded: expressions and JSX are
8993
TS's verbatim and a file is a module (07 §1); declarations are keywords
9094
(`source`, `x = e`), as 07 rules.
95+
96+
## License
97+
98+
[MIT](LICENSE)

0 commit comments

Comments
 (0)