Contribution

Run the source workspace

Only contributors need the repository build pipeline. Use Node 20 or newer for the monorepo, Node 22.6 or newer for the website test runner, and the pnpm version pinned in packageManager. In an existing checkout, preserve your local changes.

git clone https://github.com/pimoludev/ui.git
cd ui
pnpm install
pnpm build:all

Choose an application

The official website uses port 3001. The Playground demonstrates every family; examples/nextjs provides a smaller integration. Run one of these commands from the repository root.

# Official website
pnpm --filter @pimolu/website dev

# Playground (run separately)
pnpm "playground dev"

# Next.js integration example (run separately)
pnpm --dir examples/nextjs dev

How packages resolve

Repository applications use workspace:* dependencies. React and core compile to dist; tokens, themes and shared styles expose generated assets. Run build:all in a fresh source checkout. npm installations already contain these outputs and do not need this command.

Verify the website

The root verify script checks the library and Playground. The website has its own checks; its dev, build, typecheck and test scripts regenerate the documentation data first.

pnpm --filter @pimolu/website typecheck
pnpm --filter @pimolu/website lint
pnpm --filter @pimolu/website test
pnpm --filter @pimolu/website build

Prepare a focused contribution

Read AGENTS.md and docs/ai/PROJECT_CONTEXT.md before changing the library. Keep public APIs, shared CSS, tests and the Playground example aligned. Generated dist files come from build scripts and should not be edited by hand.

Run the root verification pipeline for a library change. Describe the behavior changed, the tests executed and any visual or accessibility limits in your pull request.

pnpm verify