Skip to content

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

Merged
rickdijk merged 1 commit into
mainfrom
rick/fpl-40-permit-the-changelog-breakingother-split-in-octo_images
Sep 23, 2026
Merged

rickdijk merged 1 commit into
mainfrom
rick/fpl-40-permit-the-changelog-breakingother-split-in-octo_images

Conversation

@rickdijk

Copy link
Copy Markdown
Collaborator

✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)

Docs update.

⤵️ What is the current behavior?

AGENTS.md doesn't mention the ### Breaking changes / ### Other changes changelog structure as an option.

🆕 What is the new behavior (if this is a feature change)?

Permits splitting a changelog entry into ### Breaking changes and ### Other changes subsections 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.

💥 Does this PR introduce a breaking change?

No.

🐛 Recommendations for testing

Docs-only change, no code path affected.

📝 Links to relevant issues/docs

Part of the changelog format standardization across the three package repos.

🤔 Checklist before submitting

  • All projects build
  • Follows style guide lines
  • Relevant documentation was updated
  • Rebased onto current main
  • Version bumped in pubspec.yaml and dated CHANGELOG.md entry added — docs-only change, skipped per the rule above

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>
@rickdijk
rickdijk merged commit c16eadc into main Sep 23, 2026
9 checks passed
@rickdijk
rickdijk deleted the rick/fpl-40-permit-the-changelog-breakingother-split-in-octo_images branch September 23, 2026 19:24
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