Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ pnpm preflight --quick # minutes: the changed packages, files and
change, scoped the way CI scopes them: the typecheck of the changed packages
and the packages that depend on them, ESLint on the changed files and Prettier on the changed TypeScript and Markdown files
and `pnpm check:repo`, the Vitest tests the change reaches in each project,
`pnpm check:knowledge` and `pnpm check:changesets`. With `--browser` it also
`pnpm check:knowledge`, `pnpm check:changesets` and `pnpm lab:sync --check`. With `--browser` it also
builds Storybook and runs the accessibility and Chromium interaction specs the
change selects. It prints one PASS, FAIL or SKIP line a check, the command of
each failing check, and "ready to flip" or "not ready: N"; it exits 1 when a
Expand All @@ -161,7 +161,7 @@ jobs.

`--quick` runs `pnpm review:pre`, the typecheck of the changed packages alone,
ESLint on the changed files, the changed test files alone, `pnpm check:knowledge`
and `pnpm check:changesets`, in minutes. It is not CI-equivalent: it builds
`pnpm check:changesets` and `pnpm lab:sync --check`, in minutes. It is not CI-equivalent: it builds
nothing, leaves out dependent packages, the tests the change reaches through an
import, and the guards, and it ends with "run `pnpm preflight` before you flip"
rather than "ready to flip". When every typecheck error names a workspace
Expand All @@ -174,6 +174,12 @@ preflight again.
Preflight is not a required step. It reproduces the pre-review checklist and
CI's checks; it does not reproduce a reviewer's judgment.

After you add a Lab component, run `pnpm lab:sync`. It writes the
component's shadcn route-lock entries and, when its doc names a required prop
with no default, a swizzle sample stub in `packages/lab/swizzle-samples.mjs`
(marked "generated by lab:sync; edit freely"). It never changes an existing
sample. `pnpm lab:sync --check` names what is missing and exits 1.

### Find the governing records by hand

| Command | What it answers |
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
"rtl:audit": "node apps/storybook/rtl-audit/rtl-audit.mjs",
"lab:readiness": "node internal/lab-readiness/audit.mjs",
"lab:readiness:check": "node internal/lab-readiness/audit.mjs --check",
"lab:sync": "node scripts/lab-sync.mjs",
"guard:modal-close": "node .github/scripts/modal-close-visibility.js",
"guard:modal-close:webkit": "node .github/scripts/modal-close-visibility.js --browser webkit",
"guard:theme-vars": "node .github/scripts/theme-var-reachability.js",
Expand Down
Loading