Contributing
Help improve the library, the examples, and the documentation. Start with a concrete behavior and the public API boundary.
Work in the Bun + Moon workspace
packages/solux owns the public library and its package tests; apps/website owns this Solid documentation site. Shared tooling lives at the root. Read AGENTS.md, CODING_STANDARD.md, and the workspace guide before choosing commands. Use the checked-in manifests and Moon configuration as the authority.
The website’s build and dev tasks depend on the library build. The browser suite uses the production Vite preview. Website deployment is a separate, manually invoked task; building or testing never publishes the site.
bun moon run solux:build
bun moon run website:dev
bun moon run website:typecheck
bun moon run website:build
bun moon run website:test-browserMake a behavior reproducible
For a bug report, include the package version, a small reproduction, the expected transition, and what actually happened. For lifecycle or DevTools bugs, include how the store was created and cleaned up, whether multiple stores were open, and whether the extension was installed.
Keep public imports, type inference, and packed declarations usable. Add focused library tests for behavior changes and browser coverage for documentation examples. The repository is MIT licensed.