Drop changelog entries for tooling this repository does not have - #25
Merged
Conversation
The Development Tools list in the v0.1.0 notes names three things that are not in the tree: a project documentation file, a set of git hooks, and a VS Code configuration. None of the three appears anywhere in the history, and nothing in the documentation explains how one would install the hooks. The coding style guide is the only entry that names something real. The list is published as part of the documentation site, so it sends readers looking for files that are not there.
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.
What
Three entries in the
v0.1.0release notes name things this repository does notcontain:
None of the three appears anywhere in the history — neither added nor removed —
and nothing in the documentation explains how one would install the hooks.
CODINGSTYLE.md, the fourth entry in that list, does exist and stays.Why it matters
The changelog is rendered as part of the documentation site, so the list sends
readers looking for files that are not there.
On editing release notes
Release notes record what a release contained, so rewriting them is normally off
limits. These three entries never described anything that existed, in that
release or in any other, so removing them corrects a record rather than revising
one.