Skip to content

Commit 6670e36

Browse files
rickdijkclaude
andauthored
docs: permit the breaking/other changelog split for breaking releases (#533)
AGENTS.md didn't mention the ### Breaking changes / ### Other changes changelog structure as an option. Permit it for a release that includes a breaking change, citing cached_network_image 4.0.0 as the worked example; not required for an ordinary release. Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
1 parent b1433c4 commit 6670e36

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,10 @@ edit changelogs.
247247

248248
`CHANGELOG.md` uses `## [x.y.z] - YYYY-MM-DD` headings with `*` bullets and has no
249249
`## [Unreleased]` section. Match that format and do not add an `[Unreleased]` section.
250+
For a release with a breaking change, you may split the entry into `### Breaking
251+
changes` and `### Other changes` subsections instead of a flat list —
252+
`cached_network_image` 4.0.0 is the worked example. Not required for an ordinary
253+
release.
250254

251255
Keep branch names out of URLs in `pubspec.yaml` and docs; published versions are immutable, so a
252256
branch-specific link becomes a permanent dead link once that branch is gone.

0 commit comments

Comments
 (0)