docs(changelog): drop dangling scaffold comment#41
Merged
Conversation
The "<!-- Future entries land here -->" block in the scaffold gets shoved below each new release entry by the workflow's prepend logic, producing an awkward layout after the first release. Drop it — the workflow file itself documents the prepend semantics in its header comment, so the same explanation isn't needed in CHANGELOG.md.
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.
Cosmetic followup. The scaffold's HTML comment block ('Future entries land here…') gets shoved below each new release entry by the prepend logic, so after a few releases the layout drifts. Drop the comment — the workflow file's own header comment already documents the prepend semantics.