Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Conversation

@chinmaygarde
Copy link
Contributor

This contains the macros mentioned in the draft detailing how we could manage breaking changes in the public Flutter engine APIs. The draft is available here.

/**
CHANGELOG:
November 29, 2017: Added a CHANGELOG section.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the changelog useful beyond the git history? In my experience, changelogs are always incomplete and rarely that useful...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a better place to put just the breaking changes. The engine Git history if full of messages the user of the public API will never care about.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case I think we should label this "BREAKING CHANGES", rather than changelog, and we should update the docs for the macros to remind people to add things to this list, and we should update our wiki page to point to this file and say to update it, etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I am waiting for comments on the doc. But if the suggestions are fine, I will just move it to the wiki.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants