Skip to content

Contributing

Thanks for improving @manovaspace/* — MIT TypeScript libraries on npm and GitHub.

Change Repo
build, tsconfig, markdown, pwa, observability manovaspace/ts
tokens, ui, devtools manovaspace/design-system
This documentation site manovaspace/docs
  1. Scope — Keep packages generic and reusable. No client product names, private URLs, or new Orbit-prefixed package names on npm.
  2. Changeset — User-facing package changes need a changeset in that package repo.
  3. Docs — API changes that affect consumers should update this site (or link a docs PR).
Terminal window
bun install --frozen-lockfile
bun run build
bun run test
bun run typecheck
bun run lint
Terminal window
bun run changeset

Pick affected packages and the semver bump. Commit .changeset/*.md with your PR.

Releases: ts RELEASING.md · design-system RELEASING.md

The package source repos and this single Starlight app declare Bun 1.4.0 and Node >=24. Use their committed bun.lock; consumer installation examples may use another manager.

Terminal window
bun install --frozen-lockfile
bun run dev
bun run build

Run commands from the selected checkout. Work on a topic branch and open a PR; package code and local API docs share a PR, with a linked site PR for guides. Public setup and checks require no private handbook, staff identity or MCP. Site CI builds/checks PRs and deploys successful merged main builds to gh-pages. Astro check covers type/content diagnostics; verify edited links separately. The site currently has English content with no extra locale configured. See SECURITY.md for conditional private-report routing; no private-channel availability is assumed.

Some TypeScript exports still use Orbit* names (for example OrbitDevtoolsProvider, OrbitTokensRaw). The product and npm packages are @manovaspace/*. Prefer documenting the real export name; a rename is tracked separately and is not required for contributions.

Open a GitHub issue or an issue on the package repo.