Skip to content
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

[Pigeon] readme updates #3705

Merged
merged 29 commits into from
Jun 30, 2023
Merged

[Pigeon] readme updates #3705

merged 29 commits into from
Jun 30, 2023

Conversation

tarrinneal
Copy link
Contributor

@tarrinneal tarrinneal commented Apr 13, 2023

Updates README's to better reflect modern pigeon and it's usage.
Very open to feedback on this, please let me know what could be better, clearer, or is just missing from this documentation.
I don't expect to be able to cover all uses with this, if people want to see all possibilities, I think looking into our very thorough integration tests will provide them with anything they could need (all of which is linked in the example README).

fixes flutter/flutter#66511
partial work for flutter/flutter#123851
fixes flutter/flutter#108531
fixes flutter/flutter#92641

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.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@tarrinneal tarrinneal marked this pull request as ready for review June 23, 2023 21:22
@tarrinneal tarrinneal marked this pull request as draft June 24, 2023 02:09
@tarrinneal tarrinneal removed the request for review from stuartmorgan June 24, 2023 02:09
@tarrinneal tarrinneal marked this pull request as ready for review June 26, 2023 19:00
@tarrinneal
Copy link
Contributor Author

@bparrishMines Can you read through the 2 README files here and see if you think they could be improved?

packages/pigeon/README.md Outdated Show resolved Hide resolved
packages/pigeon/example/README.md Show resolved Hide resolved
packages/pigeon/example/README.md Outdated Show resolved Hide resolved
packages/pigeon/example/README.md Outdated Show resolved Hide resolved
packages/pigeon/example/README.md Show resolved Hide resolved
packages/pigeon/example/README.md Outdated Show resolved Hide resolved
packages/pigeon/lib/pigeon_lib.dart Outdated Show resolved Hide resolved
packages/pigeon/tool/run_tests.dart Outdated Show resolved Hide resolved
Copy link
Contributor

@stuartmorgan stuartmorgan left a comment

Choose a reason for hiding this comment

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

LGTM with one more thing.

packages/pigeon/lib/pigeon_lib.dart Outdated Show resolved Hide resolved
@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Jun 30, 2023
@auto-submit auto-submit bot merged commit d3c0d5f into flutter:main Jun 30, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 3, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jul 3, 2023
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Jul 3, 2023
flutter/packages@53ed5a0...cdae854

2023-07-01 [email protected] Roll Flutter from ff838bc to aa5f4a2 (29 revisions) (flutter/packages#4363)
2023-07-01 [email protected] [tool] Add a flag to skip cleanup (flutter/packages#4357)
2023-07-01 [email protected] [file_selector] Endorse Android (flutter/packages#4329)
2023-07-01 [email protected] [google_sign_in] Convert Android to Pigeon (flutter/packages#4344)
2023-06-30 [email protected] [Pigeon] readme updates (flutter/packages#3705)
2023-06-30 [email protected] [camera_android] Support concurrently image capture and image streaming (flutter/packages#4332)
2023-06-30 [email protected] Prepare for utf8.encode() to return more precise Uint8List type (flutter/packages#4342)
2023-06-30 [email protected] [shared_preferences] Adds allowList to setPrefix method. (flutter/packages#3794)
2023-06-30 [email protected] Roll Flutter from 51bef1b to ff838bc (12 revisions) (flutter/packages#4346)

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-flutter-autoroll
Please CC [email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

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

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants