Contributing

Workspace

packages/kappa contains the Vue library. packages/kappa-docs-astro contains the documentation, demos, and browser tests.

Add reusable controls to packages/kappa/src/components and application blocks to packages/kappa/src/blocks. Put guides and demos in the docs package. See Components and Blocks for examples.

Run the commands below from the repository root.

Set Up

Use the Node.js and pnpm versions listed in the root package.json. Install dependencies and start the documentation site:

corepack enable
pnpm install
pnpm dev

To run browser tests, install Chromium:

pnpm --filter @dicehub/kappa-docs-astro exec playwright install chromium

Make a Change

• Use an Ark UI Vue primitive when one exists. Kappa defines its public API and visual design.
• When you change a public component or block, update its exports, documentation, demo, and relevant tests.
• For registry or theme changes, edit the source and run its generator. Do not edit generated files by hand.
• Add a changeset for each user-visible package change. Documentation-only changes do not need one.

pnpm --filter @dicehub/kappa codegen:registry
pnpm --filter @dicehub/kappa codegen:themes
pnpm changeset

Run the commands that apply to your change. See Registry and Colors for the source files.

Verify

Run tests for the code you change while you work. Before you submit a change, check the types, build, and test suite:

pnpm typecheck
pnpm build
pnpm test

If you change exports or package output, also validate the packed package:

pnpm --filter @dicehub/kappa validate:package

For release work, follow docs/RELEASING.md in the repository. CI publishes the package from protected tags.