Skip to content

type gets its own changelog before it needs one - #404

Merged
nyblnet merged 1 commit into
mainfrom
docs/type-changelog
Aug 29, 2026
Merged

type gets its own changelog before it needs one#404
nyblnet merged 1 commit into
mainfrom
docs/type-changelog

Conversation

@nyblnet

@nyblnet nyblnet commented Aug 29, 2026

Copy link
Copy Markdown
Owner

bento/type had no changelog. 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.

One new file, 21 lines. No type/src file 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 where PARALLEL-WORK.md never repeated it:

The notes ride inside the signed update manifest and are what someone reads while deciding whether to rewrite their file — so an app must never describe another app's changes.

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

Verified against origin/main = 220f7e7.

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.
@github-actions

Copy link
Copy Markdown

Build size

main (220f7e7) → docs/type-changelog (7542b6b)

app base PR change
bento/slides 669.3 KiB 669.3 KiB 0.0 KiB (0.00%)
bento/spaces 267.6 KiB 267.6 KiB 0.0 KiB (0.00%)
bento/dash 161.3 KiB 161.3 KiB 0.0 KiB (0.00%)

Updated: 2026-08-29T07:29:12Z

@nyblnet
nyblnet merged commit d96842c into main Aug 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant