Skip to content

Conversation

@stuartmorgan-g
Copy link
Collaborator

Updates the boilerplate text about endorsement in the implementation package READMEs to avoid confusion. There are cases where clients may use the implementation packages directly (most often, to call platform-specific extensions), and the old text was leading some people to believe they shouldn't depend on the package when they did so. This clarifies that while the common use case of indirect usage doesn't require a dependency, direct usage does.

Fixes flutter/flutter#121757

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

Copy link
Member

@ditman ditman left a comment

Choose a reason for hiding this comment

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

Ship it! I also like the explanation on not endorsed packages!

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 8, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 8, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Mar 8, 2023

auto label is removed for flutter/packages, pr: 3404, due to - The status or check suite web-platform_tests CHANNEL:stable PACKAGE_SHARDING:--shardIndex 1 --shardCount 2 has failed. Please fix the issues identified (or deflake) before re-applying this label.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 8, 2023
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Mar 8, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Mar 8, 2023

auto label is removed for flutter/packages, pr: 3404, due to - This commit is not mergeable and has conflicts. Please rebase your PR and fix all the conflicts.

@stuartmorgan-g stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Mar 8, 2023
@auto-submit auto-submit bot merged commit 6d5cb85 into flutter:main Mar 8, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 9, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Mar 9, 2023
nploi pushed a commit to nploi/packages that referenced this pull request Jul 16, 2023
[various] Clarify endorsement in READMEs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[packages] Improve README boilerplate for endorsed packages

4 participants