Docs/Contributingv1.0.0-rc.1

Framework validation

Choose checks that exercise the changed contract. Passing a source test does not certify the published archive, a real service or an application's rollout. Keep measured thresholds and mandatory gates in code and workflow configuration; the commands below explain how to run them.

Source and documentation

npm run build
npm run api:check
npm run test:docs
npm run test:release

api:check compares fresh declarations with the reviewed snapshot. Intentional differences require review and migration notes before api:snapshot updates the baseline. Documentation checking validates public imports, relative file targets, the generated inventory and complete typescript check examples. It does not execute every illustrative snippet or verify external HTTP links.

Use npm test -- --runInBand for framework tests and npm test -- --coverage --detectOpenHandles --runInBand for measured coverage. On affected PowerShell installations, use npm.cmd when forwarding arguments. package.json owns the actual global and per-file thresholds; they are regression floors rather than stable-release quality targets. Do not lower them to hide a regression.

Packed consumers

npm run build:publish
npm run test:consumer
npm run test:consumer:all

The harness installs a fresh archive outside the repository, checks independent dependencies and audits, and compiles declarations strictly. The full profile includes optional peers and shared DI identity checks. The API snapshot expands wildcard declaration entries, so its entry count is not the number of explicit package export keys.

Real-browser packed consumer

node node_modules/playwright/cli.js install chromium firefox webkit
npm run test:browser

A focused local run can use npm run test:browser -- --browser=chromium. CI and publication require all configured engines. The harness bundles the actual packed browser surfaces without source aliases or Node polyfills, blocks external traffic, tests selected DOM/state/storage/MFE behaviors and retains versions, archive integrity, scenario results and failure traces under build/release-evidence/. These are bounded compatibility/lifecycle smoke checks; they do not establish every browser feature or real provider behavior.

Services and release gates

npm run test:services uses the test harness's disposable service fixtures. Use the designated trusted service runner; never point it at production databases. Retain actual service versions, ports, results and cleanup failures.

Release checks also require the configured audits, strict OpenAPI comparison, packaged content checks and exact release metadata. Comparator failure cannot be interpreted as an empty compatibility report. Existing readiness approval is recorded in framework docs/releases/v1-readiness.json; successful checks do not approve its pending gates or authorize stable publication.

See publishing, CI runners and source/release evidence.

From the canonical UDIOT public documentation.Try it in the playground ↗