Rework docs for flutter/packages changelogs#187666
Open
stuartmorgan-g wants to merge 1 commit into
Open
Conversation
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.
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
NEXTsection 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.