-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Changelog entry for 3.35.5 #176103
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.
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
Changelog entry for 3.35.5 #176103
Conversation
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a changelog entry for version 3.35.5 to CHANGELOG.md. The new section includes two items: a fix for an issue where a Flutter view may hang in iOS add-to-app scenarios, and a fix for incorrect display of multiple cursors.
CHANGELOG.md
Outdated
| - [flutter/172105](https://github.com/flutter/flutter/issues/172105) Fixes issue in iOS add-to-app where Flutter view may hang after multiple transitions. | ||
| - [flutter/173106](https://github.com/flutter/flutter/issues/173106) Fixes an issue where multiple cursors were shown incorrectly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting of these changelog entries is inconsistent with others in this file. A hyphen (-) should be added after the issue link for consistency.
Additionally, the descriptions could be more specific to better help users, as recommended by the project's hotfix documentation best practices.1
For example:
- The first entry could be rephrased to be more direct:
On iOS, the Flutter view in an add-to-app may hang after multiple transitions. - The second entry is a bit vague. Based on the linked issue, a more descriptive summary would be:
When aTextFieldhasmaxLinesset to null and is scrolled, multiple cursors may be shown incorrectly.
Here is a suggested update that applies these improvements:
| - [flutter/172105](https://github.com/flutter/flutter/issues/172105) Fixes issue in iOS add-to-app where Flutter view may hang after multiple transitions. | |
| - [flutter/173106](https://github.com/flutter/flutter/issues/173106) Fixes an issue where multiple cursors were shown incorrectly. | |
| - [flutter/172105](https://github.com/flutter/flutter/issues/172105) - On iOS, the Flutter view in an add-to-app may hang after multiple transitions. | |
| - [flutter/173106](https://github.com/flutter/flutter/issues/173106) - When a `TextField` has `maxLines` set to null and is scrolled, multiple cursors may be shown incorrectly. |
Style Guide References
Footnotes
-
The project's hotfix documentation best practices (in
docs/releases/Hotfix-Documentation-Best-Practices.md) recommend that changelog entries should be clear, succinct, and describe the problem, platform, and context to help users quickly assess if a fix is relevant to them. ↩
reidbaker
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Follow the change log guidance
bug link - On platform simple change description that describes either the bad behavior or corrected behavior.
ac4e799
into
flutter:flutter-3.35-candidate.0
I accidentally only made the changelog updates on the release branch (#176103), but it seems it should have been done on master.
I accidentally only made the changelog updates on the release branch (flutter#176103), but it seems it should have been done on master.
I accidentally only made the changelog updates on the release branch (flutter#176103), but it seems it should have been done on master.
Changelog update for stable hotfix. These are the cherry picks:
#176030
#176048