docs: write the release note for the reader, not the author - #193
Merged
Conversation
- cut 1.0.2's entry from 54 lines to 22: the four bullets of corrections to this repository's own documents told a blogger nothing about whether to upgrade - keep the one correction that does bear on the decision, that 1.0.1 described index.xml as untouched when its version line had changed - say in CONTRIBUTING what the note is for, since the entry is the note
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.
1.0.2's note ran to 54 lines, four of its bullets listing corrections made to
SECURITY.md,ADR-0003and the readme. None of that helps someone decidewhether to upgrade a skin, and the changelog entry is the published release
note.
Cut to 22 lines: which two files to upload, what happens to
index.xmlandtherefore to their settings, and the two things that were fixed.
One correction is kept, because it bears directly on the decision the reader is
making as they read it — 1.0.1 told them
index.xmlwas untouched when itsversion line had changed the same way this release changes it.
CONTRIBUTING now says what the note is for, so the next one starts there.
The published release notes are updated to match. The archive and its checksum
are untouched — notes are not part of either.