type gets its own changelog before it needs one - #404
Merged
Conversation
bento/type had no changelog. The root CHANGELOG.md is bento/slides' (slides/ has none of its own), spaces/ and dash/ have had theirs for weeks, and type/ was missed when the apps multiplied. docs/PARALLEL-WORK.md §3 names CHANGELOG.md as the first conflict magnet and already said each app gets its own; this closes the gap it named. Timing is the point. The maintainer is about to work type and spaces concurrently, a slides release is in flight with an open PR on the root file, and type is one user-facing change away from having nowhere correct to write. An empty file now costs nothing; the same file created mid-conflict costs a rebase on someone else's branch. The preamble carries the reason a cross-app entry is a correctness defect rather than untidiness, lifted from spaces/CHANGELOG.md where it was already stated: release notes ride inside the SIGNED update manifest and are what someone reads while deciding whether to rewrite their file, so an app describing another app's changes tells a user about changes their document did not get. [Unreleased] is empty and says so. type is 0.1.0 with no tag, so pre-release work belongs in the first release's entry — I did not invent entries for its four commits, because their user-facing meaning is bento/type's to state, not mine. No type/src file touched.
Build size
Updated: |
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.
bento/type had no changelog. Root
CHANGELOG.mdis bento/slides' (slides/has none of its own),spaces/anddash/have had theirs for weeks, andtype/was missed when the apps multiplied.docs/PARALLEL-WORK.md§3 namesCHANGELOG.mdas the first conflict magnet and already said each app gets its own — this closes the gap it named.One new file, 21 lines. No
type/srcfile touched.Why now rather than when type needs it
The maintainer is about to work type and spaces concurrently, a slides release is in flight with PR #400 open on the root file, and type is one user-facing change away from having nowhere correct to write. An empty file now costs nothing; the same file created mid-conflict costs a rebase on someone else's branch.
The preamble carries the reason, not just the rule
Lifted from
spaces/CHANGELOG.md, where it was already stated and wherePARALLEL-WORK.mdnever repeated it:That makes a cross-app entry a correctness defect, not untidiness: a user reading notes about changes their document did not get, inside a signed artifact. Worth stating in the file someone actually has open when they are about to append.
What I did not do
0.1.0with no tag.[Unreleased]is empty and says so; pre-release work belongs in the first release's entry. The user-facing meaning of type's four commits is bento/type's to state, not mine.slides/CHANGELOG.md.PARALLEL-WORK.mdpoints at that as the eventual shape, but doing it now would collide head-on with Reconstruct CHANGELOG [Unreleased] — the code morph was missing from it entirely #400 and with a release in flight. Filed as a follow-up rather than folded in; the amended §3 in The locale list leaves the prose, and pt is logged as an open question #401 records that the root file is slides' and has not moved yet, so nobody reads the gap as an accident.Verified against
origin/main=220f7e7.