docs: out of beta, and what 1.0 promises - #13
Merged
Merged
Conversation
The beta framing goes; in its place, what a major means: within 1.x the commands, flags, config keys, drop-in names, metric names and the /history.json fields stay as they are, and a change that would break any of them bumps the major. The installation and releasing examples use v1.0.0, and the note on what latest means covers a stable release with pre-releases beside it.
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.
TLDR
The beta line goes from README, index and SECURITY.md. A short section says what 1.x promises (stable commands, flags, config keys, drop-in names, metric names, history fields; breaking changes bump the major). Examples use v1.0.0. No code change.