Repository navigation
docs: explain release status labels in README - #5
Merged
Merged
Conversation
Explain what the Latest and Pre-release labels mean so readers can tell whether a build has completed the browser checklist before installing it. Worded to stay accurate for future releases rather than naming the current version, so it does not need updating on every release. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a short subsection to
README.mdexplaining what the Latest and Pre-release labels on the Releases page mean, so a reader can tell whether a build has completed the browser checklist before installing it.Why
v2.3.0is published as a pre-release because the browser checklist inTEST_CHECKLIST.mdhas not been completed and recorded. The release notes say so, and GitHub shows aPre-releasebadge, but nothing in the README told a reader that the badge carries that meaning.Design note
The wording deliberately does not name the current version or its current status. It explains what the labels mean in general, so it stays accurate for every future release and does not need editing each time one is published. A version-specific note would go stale as soon as a stable release is published.
Effect on the release archive
README.mdis one of the files listed inscripts/release-files.mjs, so merging this changes the generated ZIP and its checksum. This does not affect the already-publishedv2.3.0assets, which remain immutable and still verify against their published checksum. Rebuilding from thev2.3.0tag still reproduces the published archive.Testing
npm run checkpasses.