Contributors
This section is for people contributing to Svelar itself, not for developers using Svelar inside an application.
User-facing guides should stay focused on building apps with Svelar. Contributor documentation should cover repository workflows, release gates, local certification, package publishing, and project-maintenance rules.
Working on Svelar
Before changing core behavior, prefer a small, production-shaped test that proves the framework works in a generated app. Unit tests are still useful, but release confidence comes from testing the package the way users will consume it.
Use the sibling svelar-testing-area folder for generated apps and external-service smoke tests. Service-backed smoke commands start Docker containers on random localhost ports so they do not require default ports to be free.
Keep repository and generated-app agent instructions aligned with public runtime contracts. HTTP generators require an explicit capability decision (--capability or a reviewed --public exemption); neither choice disables authentication, model policies, schema validation or CSRF. Seed capability catalogs and profiles instead of hardcoding user grants. Operator controls must use public named queue adapters and persistent scheduler requests, and realtime must remain a signal over durable background state.
Svelar-specific skills take precedence over generic Svelte examples: thin routes, controllers, shared-schema Superforms/FormRequests, DTOs, actions/services, repositories and resources remain required. Maintain ESM import paths, Tailwind 4 configuration, custom-primary-key auth identity, awaited global exception reporting and isolated asynchronous factories in the generated instructions. Regenerate packaged Claude skills when their source/references change, and prove fresh installed apps receive the current instructions. Worker recovery claims require owned native processes and public adapters; cache/realtime readiness is not proof of distributed delivery.
Documentation Sync
When documentation changes in this repository, mirror the equivalent changes in:
/Users/rzeradev/projects/beeblock/svelar-docs/
Keep the docs search registry in sync too:
/Users/rzeradev/projects/beeblock/svelar-docs/src/lib/doc-registry.ts
Contributor Guides
- Release Certification — pre-publish gates and generated-app certification coverage.