Skip to main content
Documentation

Contributing — Join the lab

BUILD IT with us.

A precise, Node-first contributor workflow for the Web Standards Lab.

01 — Setup

git clone https://github.com/open-element/openelement.git
cd openelement
pnpm install
pnpm test

openElement core CLI, SSG, serverless API, tests, publishing, and docs site tasks all run on Node 24.2+ with pnpm as the package manager. Tasks go through pnpm run <task> or the vp task runner — no npm or npx global installs in the main workflow.

Release line

  1. Run pnpm --dir tools/repo run version-bump
  2. Update the changelog
  3. Run pnpm test
  4. Publish via pnpm --dir tools/release run pack:dry-run, pnpm run release:check, pnpm --dir tools/release run publish:npm
  5. Create the GitHub Release

02 — Before a PR

  • pnpm run fmt + pnpm run lint stay clean
  • Conventional Commits (feat / fix / docs / refactor / test / chore)
  • Gates green locally — pnpm run check + pnpm test before push
  • Architectural change? Write the ADR first

Layering discipline: before adding a feature, check whether it can be solved at a lower level — L0 HTML, L1 CSS, L2 Browser API, L3 Hono/Vite/Lit, then L4 custom code.

03 — Where to help

Third-party WC corpus

Lit / FAST / Stencil components that render through our DSD smoke pipeline, with evidence.

Dogfood something real

Build an application on the stable line and file what breaks. That is the pilot now.

Documentation truth

Run the docs gates, fix stale claims, and keep the public surface evidence-backed.

ChangelogRoadmap