BuildWithMe UI / Handbook

Start small. Build with us.

Documentation, accessibility review, bug reproduction, and focused fixes are first-class contributions. Three-framework work is required only for a new design or a shared capability change.

Your first ten minutes

Choose a good-first-issue, create a branch, and make one clear documentation, copy, accessibility, or website fix. The root FIRST_CONTRIBUTION.md guide provides the exact path.

git switch -c docs/clearer-installation
pnpm dev

Improve one framework

A focused fix to an existing React, Vue, or Svelte source is welcome. Describe what you tested and avoid changing the shared capability without coordinating parity.

Add a complete design

New designs are the advanced path. The scaffold creates a manifest and three framework sources while generated tooling handles repetitive catalog and package output.

pnpm component:new signal-card data-display css

Validate what changed

Documentation needs link review. Website code needs lint and type checking. CI runs one lightweight job for code, types, unit tests, and registry validation. Browser and installation suites are optional local checks when the change needs them.

pnpm lint && pnpm typecheck

Credit source work

Original documentation needs no provenance record. Component source and visual adaptations retain their creator, upstream URL when applicable, license, and modification note.

Open the pull request

Explain the problem, the resulting behavior, and the checks you ran. Include screenshots for visible changes when available and report unrelated check failures without expanding the scope.