Skip to content

Quality

Quality in Vellira covers documentation, type definitions, component behavior, testing, and package publishing.

CI Gates

The main CI workflow validates:

  • formatting and linting;
  • package builds;
  • documentation builds;
  • TypeScript type checking;
  • generated API documentation;
  • public API snapshot verification;
  • unit tests and coverage;
  • Storybook and end-to-end tests;
  • package smoke tests.

Dependency Updates

Dependabot opens automatic pull requests for dependency updates.

The repository checks npm workspace dependencies and GitHub Actions weekly. Related npm updates are grouped for React, Storybook, Vite, Expo, and linting tooling.

Local Commands

Run the full pipeline before opening a significant pull request.

bash
pnpm ci

Focused checks are faster while developing.

bash
pnpm docs:build
pnpm typecheck
pnpm test
pnpm check:public-api
pnpm smoke:packages

Documentation Quality

Documentation should explain:

  • why a package exists;
  • how to install it;
  • how to build the first working example;
  • how state is controlled;
  • how tokens and themes are applied;
  • how to test and review the result.

If a public API changes, update the package docs and VitePress pages in the same pull request.

Release Quality

Published packages are validated through smoke tests, public export checks, and automated release verification.

These checks help prevent broken package entry points, missing type declarations, and unintended API changes.

Principles

Quality checks should be automated whenever possible.

Every public change should be validated before release through documentation, tests, type checking, and CI.

Built for Vellira Design System.