Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (65 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

87 lines (65 loc) · 2.97 KB
Raw

Developing guide

Running locally

npm ci
npm run dev

Testing

npm run build
npm run check
npm run test:e2e

When component APIs change, regenerate and commit the generated files:

npm run build:codegen

Releases

Include a changeset with changes that need a release:

npx changeset

Choose the version bump, describe the user-visible change, and commit the generated file with your implementation. Docs-only and development-tooling changes do not need a changeset.

Review and merge the release PR when ready. A PR opened by the Changesets workflow may have no automatic checks. Run Test and lint on its changeset-release/main branch and wait for the required check to pass. To refresh the release PR, run Update release PR on main.

After staging, review the package on npm's Staged Packages page and approve with 2FA, or run:

npm stage approve <stage-id>

Use the stage ID from the workflow log. Approve versions in order to avoid moving latest backward.

Local preparation and prereleases

To prepare a release locally instead of using the bot:

npm ci
npm run build
npm run check
npx changeset version

Review and commit the version, changelog, and consumed changesets, then merge through a checked PR. A push to main stages the latest version-bump commit in that push.

For a branch prerelease, prepare a prerelease version with Changesets and dispatch Release from the Actions page on that branch. The first prerelease identifier selects the npm channel, such as alpha. Stable releases require main.

Recovery

If staging has not been attempted, dispatch Release on the appropriate ref with the 40-character SHA of a version-bump commit reachable from that ref. Once staging starts, inspect npm before retrying: dispatching Release runs npm stage publish again. If the package is already staged, retry only the failed tag job or, after verifying the staged version, create its source tag at the version-bump commit.

Failure Recovery
Failure before staging was attempted Retry failed jobs for the same commit.
Staging succeeded; tagging failed Retry only the failed tag job, or create the source tag after verifying staging.
Upload outcome uncertain Inspect npm; retry staging only if absent, or recover the tag if already staged.
Fix requires changing the release commit's code Prepare a new version-bump commit.
Candidate rejected after staging Leave its tag and prepare a new version.