Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

[tools] Require implementation package README warning #6459

Merged
merged 4 commits into from
Sep 22, 2022

Conversation

stuartmorgan
Copy link
Contributor

Ensures that the README in the example of a federated plugin implementation package explains that it is intended as a testbed, not a real example to follow.

Updates the existing READMEs accordingly to fix violations of the new check.

Fixes flutter/flutter#111904

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/plugins repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the plugin 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.

Ensures that the README in the example of a federated plugin
implementation package explains that it is intended as a testbed, not a
real example to follow.

Updates the existing READMEs accordingly to fix violations of the new
check.

Fixes flutter/flutter#111904
@stuartmorgan
Copy link
Contributor Author

I only updated one README, so that it can be reviewed, and updated as necessary. Once we're happy with the text I'll update the PR to duplicate it into every implementation package.

@stuartmorgan stuartmorgan added the override: no changelog needed Override the check requiring CHANGELOG updates for most changes label Sep 21, 2022
Copy link
Member

@cbracken cbracken left a comment

Choose a reason for hiding this comment

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

LGTM stamp from a Japanese personal seal

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

Successfully merging this pull request may close these issues.

[plugins] Add README warning to implementation package examples
2 participants