Community

Contributing

Name: Vui Starter
Author: Suman Bonakurthi

Vui Starter is MIT-licensed and open to contributions: bug fixes, new components, docs, and demos are all welcome. This page covers changing the theme itself; to build your own app with VUI, see Building with AI agents instead.

Which guide do I need?

Two scenarios, two homes for the rules. Contributing to the theme (this page): humans follow CONTRIBUTING.md, agents follow AGENTS.md. Using the theme in your own app: see Building with AI agents.

Local setup

Requires Node 18+ and pnpm 9+.

terminal

git clone https://github.com/myviliha/vui-starter.git
cd vui-starter
pnpm install
pnpm dev            # backoffice + docs on :3000

Contributing with an AI agent

The repo ships deterministic, machine-checkable rules for coding agents in AGENTS.md, the filename Claude Code, Cursor, and Copilot auto-load. It spells out where new components, pages, tokens, and navigation go, the hard rules (Server Components first, no any, no hard-coded design values, reuse before you create), and the commands a change must pass before it's "done". Point your agent at the repo and it holds to the same standards a human reviewer expects.

verify before a PR

pnpm --filter @viliha/vui-ui check-types
pnpm --filter backoffice lint     # eslint --max-warnings 0
pnpm --filter backoffice build

Useful scripts

terminal

pnpm dev            # run all apps
pnpm build          # build everything (Turborepo)
pnpm lint           # zero-warning lint
pnpm check-types    # type-check

Where things live

packages/ui: the @viliha/vui-ui library (edit components + theme.css here).
apps/backoffice: the admin demo that dogfoods the library and hosts this documentation site under app/docs.

Changelog & docs (required)

⚠️ Every change updates the changelog and docs

This is mandatory for everyone, humans and AI agents. In the same PR, add an entry to packages/ui/CHANGELOG.md (and bump packages/ui/package.json per semver if it ships in the package), and update every doc that describes the change: README.md, AGENT.md, the relevant /docs page, and the requirement templates. A change with no changelog or docs update is incomplete.

Pull requests

Branch off main, keep changes focused.
Run pnpm lint and pnpm check-types before pushing; CI runs lint, types, build, and security scanning on every PR.
Match the surrounding code style. The design system is token-driven, so reach for a theme.css token before any hard-coded value.
See CONTRIBUTING.md and CODE_OF_CONDUCT.md in the repo.