Skip to content

Rework docs for flutter/packages changelogs#187666

Merged
auto-submit[bot] merged 1 commit into
flutter:masterfrom
stuartmorgan-g:changelog-instructions-rework
Jun 14, 2026
Merged

Rework docs for flutter/packages changelogs#187666
auto-submit[bot] merged 1 commit into
flutter:masterfrom
stuartmorgan-g:changelog-instructions-rework

Conversation

@stuartmorgan-g

Copy link
Copy Markdown
Contributor

Updating CHANGELOGs correctly is one of the most common issues for new contributors in flutter/packages. The way the docs were written highlights using the NEXT section for version-exempt changes first, because it's unusual and specific to our repo, but given how common it is for new contributors to use it when they shouldn't, it seems like this structure is likely confusing for the people who most need the docs.

This reworks the whole section to discuss the common case first, then the uncommon case (now explicitly highlighted as uncommon) second. The new structure is a little longer, but should hopefully be more clear, which seems like a tradeoff worth trying given the frequency of issues.

Also includes some minor fixes I noticed while I was in the file (grammar, inconsistent backticks for file names), and addition of references to the new flutter/core-packages.

Updating CHANGELOGs correctly is one of the most common issues for new
contributors in flutter/packages. The way the docs were written
highlights using the `NEXT` section for version-exempt changes first,
because it's unusual and specific to our repo, but given how common it
is for new contributors to use it when they shouldn't, it seems like
this structure is likely confusing for the people who most need the
docs.

This reworks the whole section to discuss the common case first, then
the uncommon case (now explicitly highlighted as uncommon) second. The
new structure is a little longer, but should hopefully be more clear,
which seems like a tradeoff worth trying given the frequency of issues.

Also includes some minor fixes I noticed while I was in the file, and
addition of references to the new flutter/core-packages.
@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Jun 8, 2026
@github-actions github-actions Bot added package flutter/packages repository. See also p: labels. team-ecosystem Owned by Ecosystem team d: docs/ flutter/flutter/docs, for contributors labels Jun 8, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 updates the contribution documentation in docs/ecosystem/contributing/README.md to include flutter/core-packages, clarify CHANGELOG update procedures for versioned and version-exempt changes, and refine external dependency definitions. A review comment points out that updating the minimum SDK version is not a version-exempt change and suggests removing it from the examples.

Comment thread docs/ecosystem/contributing/README.md

@bparrishMines bparrishMines left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 14, 2026
@auto-submit
auto-submit Bot added this pull request to the merge queue Jun 14, 2026
Merged via the queue into flutter:master with commit abd8d37 Jun 14, 2026
24 checks passed
@flutter-dashboard flutter-dashboard Bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jun 14, 2026
auto-submit Bot pushed a commit to flutter/packages that referenced this pull request Jun 15, 2026
Roll Flutter from b7cb925419e6 to 5827d5fd2b8d (35 revisions)

flutter/flutter@b7cb925...5827d5f

2026-06-15 [email protected] Roll Skia from 7128af60575a to c8d9f80f13e4 (1 revision) (flutter/flutter#188015)
2026-06-15 [email protected] In the APNG decoder, validate the chunk data length before calling GetChunkSize to avoid potential overflow in the chunk size calculation (flutter/flutter#187949)
2026-06-15 [email protected] Roll Skia from 6b4ac3bfb39d to 7128af60575a (1 revision) (flutter/flutter#188011)
2026-06-15 [email protected] Roll Skia from 0a3b8549cbf0 to 6b4ac3bfb39d (7 revisions) (flutter/flutter#188007)
2026-06-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Map some framework semantics roles to android classes.  (#185217)" (flutter/flutter#188008)
2026-06-15 [email protected] [ios] Filter UIScene events to those relating to Flutter VC scene (flutter/flutter#187987)
2026-06-15 [email protected] [a11y] Map some framework semantics roles to android classes.  (flutter/flutter#185217)
2026-06-15 [email protected] Roll Skia from f46928e7f50c to 0a3b8549cbf0 (1 revision) (flutter/flutter#188004)
2026-06-14 [email protected] Rework docs for flutter/packages changelogs (flutter/flutter#187666)
2026-06-14 [email protected] Roll Fuchsia Linux SDK from nvzMQAmuRSzo7-wAP... to TbB86Po_HDe1dvXvT... (flutter/flutter#187997)
2026-06-14 [email protected] Roll Skia from 4e2c9b5e4dad to f46928e7f50c (1 revision) (flutter/flutter#187996)
2026-06-14 [email protected] Roll Skia from c52667607242 to 4e2c9b5e4dad (1 revision) (flutter/flutter#187990)
2026-06-14 [email protected] Improve RenderTargetCache docs (flutter/flutter#187893)
2026-06-13 [email protected] [Test cross_imports] Check cross imports in flutter_test/** (flutter/flutter#187587)
2026-06-13 [email protected] Fixing corrupted window size OnEmptyFrameGenerated due to transpsed width/height (flutter/flutter#187954)
2026-06-13 [email protected] Roll Skia from 42355271a335 to c52667607242 (2 revisions) (flutter/flutter#187979)
2026-06-13 [email protected] Roll Fuchsia Linux SDK from A3eaUn9mQ_EkSNxVI... to nvzMQAmuRSzo7-wAP... (flutter/flutter#187975)
2026-06-13 [email protected] Roll Skia from 9ef46390c2d1 to 42355271a335 (1 revision) (flutter/flutter#187974)
2026-06-13 [email protected] [Flutter GPU] Make ShaderLibrary.fromAsset asynchronous (flutter/flutter#187716)
2026-06-13 [email protected] Roll Skia from 8c89bf2b0ee3 to 9ef46390c2d1 (6 revisions) (flutter/flutter#187968)
2026-06-12 [email protected] [Flutter GPU] Add surface API for framework presentation (flutter/flutter#187358)
2026-06-12 [email protected] [gen_l10n] Exclude inherited keys from untranslated-messages-file (flutter/flutter#187950)
2026-06-12 [email protected] Update `MediaQueryData` docs for devicePixelRatio overriding (flutter/flutter#187542)
2026-06-12 [email protected] [Impeller] Fix dirty-range race in DeviceBufferGLES uploads (flutter/flutter#187932)
2026-06-12 [email protected] Compare isModifiedAfter against the given time (flutter/flutter#187727)
2026-06-12 [email protected] Enable unit tests for compilation of compute shaders on non-metal backends (flutter/flutter#179683)
2026-06-12 [email protected] [flutter_tools] Add doctor validator warning for multiple adb installations (flutter/flutter#186031)
2026-06-12 [email protected] Optimize SHA hash calculation of generated APK (flutter/flutter#187184)
2026-06-12 [email protected] Scope widget inspector overlay to the selected widget's modal route (flutter/flutter#186784)
2026-06-12 [email protected] Switches Windows to OpenGLESSDF (flutter/flutter#187877)
2026-06-12 [email protected] [integration_test] Update README to support modern Kotlin-based setups by default (flutter/flutter#186080)
2026-06-12 [email protected] Convert the PNG signature constant in APNGImageGenerator to a std::array and use it in the APNG tests (flutter/flutter#187930)
2026-06-12 [email protected] Correct backoff retry time cap unit and add regression tests (flutter/flutter#187250)
2026-06-12 [email protected] Fix std::vector out-of-bounds access in Flutter Android JNI and Delegate (flutter/flutter#187218)
2026-06-12 [email protected] [Android] Adding 30-second timeouts to adb stopApp and uninstallApp (flutter/flutter#187876)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622
...
via-guy pushed a commit to via-guy/flutter that referenced this pull request Jun 26, 2026
Updating CHANGELOGs correctly is one of the most common issues for new
contributors in flutter/packages. The way the docs were written
highlights using the `NEXT` section for version-exempt changes first,
because it's unusual and specific to our repo, but given how common it
is for new contributors to use it when they shouldn't, it seems like
this structure is likely confusing for the people who most need the
docs.

This reworks the whole section to discuss the common case first, then
the uncommon case (now explicitly highlighted as uncommon) second. The
new structure is a little longer, but should hopefully be more clear,
which seems like a tradeoff worth trying given the frequency of issues.

Also includes some minor fixes I noticed while I was in the file
(grammar, inconsistent backticks for file names), and addition of
references to the new flutter/core-packages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD d: docs/ flutter/flutter/docs, for contributors package flutter/packages repository. See also p: labels. team-ecosystem Owned by Ecosystem team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants