WarblerJS is an architecture-first TypeScript framework. Contributions must preserve package boundaries, deterministic behavior, protocol independence, and the public API contracts documented in each package.
- Read the relevant package documentation under
packages/<package>/docs/current. - Confirm the package owns the responsibility being changed.
- Prefer the existing implementation style.
- Keep changes scoped to the smallest package boundary that can own them.
- Ask for release-owner review before changing public APIs, compiler artifact schemas, runtime behavior, package dependency direction, security architecture, or release policy.
Run the repository gate before submitting release-bound changes:
bun run typecheck
bun run test
bun run check:versions
bun run check:cli-starter-versions
bun run check:cli-starter-configs
bun run smoke:packagesPackage-local commands remain supported:
bun run --cwd packages/core typecheck
bun run --cwd packages/core test
bun run --cwd packages/compiler typecheck
bun run --cwd packages/compiler test
bun run --cwd packages/runtime typecheck
bun run --cwd packages/runtime test
bun run --cwd packages/http typecheck
bun run --cwd packages/http test- Do not introduce runtime discovery, reflection, or decorator-driven behavior.
- Do not import internal package paths from another package.
- Do not bypass public package entry points.
- Do not add framework features in stabilization tasks.
- Do not change public APIs without release-owner review.
- Add tests for every public behavior change.
- Update documentation when release behavior, public API, or package boundaries change.
Do not remove stable APIs without release-owner approval, migration notes, changelog updates, public API test updates, and compatibility review.
Every pull request should include:
- Scope summary.
- Verification commands run.
- Public API impact.
- Security impact.
- Performance impact when relevant.
- Documentation impact.
- Compatibility impact.
- Deprecation impact when relevant.
Release-bound changes should follow docs/RELEASE.md and docs/VERSIONING.md.