Skip to content

docs: permit the breaking/other changelog split for breaking releases #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rickdijk merged 1 commit into from
Sep 23, 2026
Merged

docs: permit the breaking/other changelog split for breaking releases #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,10 @@ does not bump versions and does not edit changelogs. Never run
`CHANGELOG.md` today uses `## [x.y.z] - YYYY-MM-DD` headings with `*` bullets
and no `## [Unreleased]` section. Match that format; introducing an
`[Unreleased]` section is a separate decision and not something to do as part
of an unrelated change.
of an unrelated change. For a release with a breaking change, you may split the
entry into `### Breaking changes` and `### Other changes` subsections instead of
a flat list — `cached_network_image` 4.0.0 is the worked example. Not required
for an ordinary release.

Published versions are immutable, so keep branch names out of URLs in
`pubspec.yaml` and in docs: a branch-specific link becomes a permanent dead
Expand Down
Loading