Open the changelog the way every repository does - #45
Merged
Conversation
This file opened with twenty lines explaining the version grading, where all thirteen consuming repositories open with the same three. The long preamble rested on the belief that this repository does not follow Semantic Versioning. It does: MAJOR is an existing rule reversed or removed, MINOR a rule added, PATCH wording only, and the interface clause is a breaking API change stated literally. The below-1.0.0 shift-down sits in the space section 4 of the specification leaves open, where anything may change and nothing is guaranteed stable. What the preamble did do is keep a second copy of the grading rules, and the two had already drifted from the copy in README.md: the opening sentence reworded, `no v prefix` in one and not the other, the interface clause explained in one and cut short in the other, and a full stop where the other has a semicolon. A hand-copied rule set drifting quietly is what this repository exists to stop happening in thirteen other places; it should not be doing it to itself. The rules stay in README.md, which was already the fuller copy. No entry changes, and none is added: a consumer of the last release cannot observe the preamble of this repository's own changelog. Closes #44
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.
CHANGELOG.mdhere opened with twenty lines explaining the version grading; all thirteen consuming repositories open with the same three. This makes it the same three.The preamble was written on a wrong premise
It rested on this repository not following Semantic Versioning. It does:
The below-
1.0.0shift-down is not a deviation either. Section 4 of the specification puts0.y.zoutside its guarantees entirely: anything may change, and nothing is to be considered stable. A convention filling that space contradicts nothing.What it was actually costing
A second copy of the grading rules, and the two had already drifted from the copy in
README.md:CHANGELOG.mdREADME.mdMAJOR.MINOR.PATCH, graded by…"MAJOR.MINOR.PATCH, novprefix. The grade is defined by…"no v prefixA hand-copied rule set drifting quietly is what this repository exists to stop happening in thirteen other places. It should not be doing it to itself.
The rules stay in
README.md, which was already the fuller copy.Scope
CHANGELOG.md, preamble only. No entry is edited, added, or removed, and no entry is added for this change either — a consumer of the last release cannot observe the preamble of this repository's own changelog.Verification
bootroot's, checked by diff.[0.3.0]and everything below it is untouched, sorelease.ymlstill finds a heading matching the tag.Closes #44