Skip to content

Contribution guide

Rastry is early-stage open source software. Contributions are most useful when they preserve the shared domain rules and make behavior easier to verify.

Read the repository contribution guide, the product definition, and the relevant change records.

The dependency direction runs from apps through core/image-engine to contracts. The web package is intentionally independent: do not import Desktop code, Electrobun, Bun.Image, or user filesystem APIs into it.

Use the repository toolchain:

Terminal window
bun install
bun run check
bun --filter @rastry/web typecheck
bun --filter @rastry/web build

Keep tests in the package’s test/ tree and cover safety invariants, failure isolation, or observable behavior. Do not commit generated dist, build, .hutch, or optimized output.

Public content is English for this first release. Catalog pages must have a real example, a stable slug, a source link, and useful related links. Update CHANGELOG.md or a release entry when the public release story changes. Do not add empty SEO pages or advertise unsupported features.

Open a focused pull request with the behavior, verification performed, and any platform-specific limitation.