Proposal: more informative changelog for stable releases #163237
Labels
c: new feature
Nothing broken; request for a new capability
c: proposal
A detailed proposal for a change to Flutter
Use case
Whenever Flutter gets a new stable version, an announcement, a list of breaking changes and a changelog is posted. The announcement highlights the main big changes without going into much detail and omitting some smaller changes. The breaking changes list is explaining the breaking changes in-depth with examples and details, but only for the breaking changes.
On the other hand the changelog, which I would assume is the central piece in a release, is not very informative and helpful. It consists of a list of all the PRs that were merged since the last stable release, which is mostly PRs that don't change anything for the app developers. Some of these issues are relands, reverts, automated dependency rolls, unflaking tests and other things that don't (in my opinion) add any value to a changelog except for generating noise in an already not very easy to grasp list.
Real changes get lost in the list so developers might never even know that some shiny new feature was added or a long standing bug was fixed. Or they might not know if some change is intended or is a regression, which then leads to them opening an issue and wasting their and the Flutter maintainers time.
Proposal
I propose for Flutter to add changelogs that go over developer-facing changes and describe them in a human-readable way, while also linking to issues and PRs for the credits and context. It is already done for the hotfix releases, so I think this should also be done for the bigger and more feature-packed stable releases.
Dart's changelog is an ideal example of what I am proposing.
The text was updated successfully, but these errors were encountered: