Contributing

How to set up the project locally and contribute changes.

Setup

bash

git clone <repo-url>
cd style
pnpm install
pnpm dev

The dev server uses webpack (Turbopack is disabled due to dynamic import tracing issues with 55 demo files).

Branch Workflow

Always create a feature branch — never commit directly to dev or main. Use conventional prefixes: feat:, fix:, refactor:, chore:, docs:, test:.

bash

git checkout -b feat/my-change

Quality Checks

Run before merging. Fix formatting on touched files with pnpm prettier --write <file>.

bash

pnpm quality    # typecheck + lint + format:check

Adding Components

Edit the component in registry/ui/perimeter/
Update or create a .demo.tsx file alongside it
Run pnpm registry:build to regenerate the registry
Run pnpm collect:demos to update the demo manifest
Update CHANGELOG.md under [Unreleased]

Contributing

Setup

Branch Workflow

Quality Checks

Adding Components

Search