docs(chat): note the pre-1.0 API contract in the README - #55
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
Adds a short Status section near the top of the package README, so anyone landing on the npm page knows the API is still settling before they build on it.
The
0.xversion number already implies this by convention, but conventions are easy to miss and the alternative — hiding the release behind abetadist-tag — costs discoverability for no real benefit while there are no consumers to protect.No changeset, deliberately
filesshipsREADME.md, so this reaches npm with 0.1.0 as long as it merges before #52. Adding a changeset would give #52 a second changelog entry, which is exactly the noise #54 just removed — and the README text is part of the initial release, not a change to it.If #52 merges first, this needs a
patchchangeset instead and ships as 0.1.1.Scope
One file. Lint clean; no code, no changesets touched.