[go: nahoru, domu]

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

[google_maps_flutter] Modified README.md to fix minor syntax issues #6631

Merged
merged 6 commits into from
Dec 12, 2022

Conversation

DEVSOG12
Copy link
Contributor
@DEVSOG12 DEVSOG12 commented Oct 28, 2022

I fixed minor code style issue in the example. e.g. change final to const because final wasn't neccessary in the case.

  • Fixed minor code style issues in the README.md

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.

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

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.

Thanks for the contribution!

Any changes to code in READMEs needs to use code excerpts, so this will need to be converted as described in that documentation as part of changing it.

@DEVSOG12
Copy link
Contributor Author

Thank you @stuartmorgan!

I have added the code excerpts to the README.

@stuartmorgan
Copy link
Contributor

The excerpt process is failing in CI; it looks like you didn't set a path-base. Did this actually work when you ran it locally?

I'm going to mark this as a draft, since it's not passing CI; please feel free to mark it for review again once it's passing. Note that as part of fixing CI you'll need to do several steps that you checked off in the checklist but didn't actually do:

Please also do this as well:

  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]

(In the future, please follow the checklist, rather than just checking items in it; it's part of the template for a reason.)

@stuartmorgan stuartmorgan marked this pull request as draft October 28, 2022 18:13
@DEVSOG12 DEVSOG12 changed the title Modified README.md to fix minor syntax issues [google_maps_flutter] Modified README.md to fix minor syntax issues Nov 4, 2022
@DEVSOG12 DEVSOG12 marked this pull request as ready for review November 4, 2022 03:25
@DEVSOG12
Copy link
Contributor Author
DEVSOG12 commented Nov 4, 2022

@stuartmorgan I have fixed all the issues.

@DEVSOG12 DEVSOG12 reopened this Dec 9, 2022
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@stuartmorgan
Copy link
Contributor
stuartmorgan commented Dec 9, 2022

Sorry, I missed the earlier update. Could you address the remaining CI issues (here and here)?

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.

Please also remove this package from script/configs/temp_exclude_excerpt.yaml now that it's been converted over.

Otherwise, this looks great, thanks for contributing this!

@DEVSOG12
Copy link
Contributor Author

@stuartmorgan I have made the change, but only one test fails.

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.

I re-added the existing CHANGELOG entries that you deleted; with that, this LGTM. Thanks!

(No tests are failing, that's just the tree status.)

@stuartmorgan
Copy link
Contributor

@tarrinneal or @ditman could you do the secondary review on this README conversion to excerpts?

Copy link
Contributor
@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

Looks solid to me, it's cool to see the excerpts rules catching issues with the readme code ( with the help of @DEVSOG12 of course).

@stuartmorgan stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 12, 2022
@auto-submit auto-submit bot merged commit da4321d into flutter:main Dec 12, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2022
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 13, 2022
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Dec 13, 2022
* 13818023c [camera] Attempt to fix flaky new Android test (flutter/plugins#6831)

* da4321d01 [google_maps_flutter] Modified `README.md` to fix minor syntax issues (flutter/plugins#6631)

* e8c9731f1 Roll Flutter from eefbe85 to bd0791b (25 revisions) (flutter/plugins#6832)

* 2eb616545 Reland "[google_maps_flutter] ios: re-enable test with popup #5312" (flutter/plugins#6783)

* 738bd91d8 Update FlutterFire link (flutter/plugins#6835)

* ec2041f82 Roll Flutter from bd0791b to 15af817 (27 revisions) (flutter/plugins#6837)
gspencergoog pushed a commit to gspencergoog/flutter that referenced this pull request Jan 19, 2023
…#116996)

* 13818023c [camera] Attempt to fix flaky new Android test (flutter/plugins#6831)

* da4321d01 [google_maps_flutter] Modified `README.md` to fix minor syntax issues (flutter/plugins#6631)

* e8c9731f1 Roll Flutter from eefbe85 to bd0791b (25 revisions) (flutter/plugins#6832)

* 2eb616545 Reland "[google_maps_flutter] ios: re-enable test with popup flutter#5312" (flutter/plugins#6783)

* 738bd91d8 Update FlutterFire link (flutter/plugins#6835)

* ec2041f82 Roll Flutter from bd0791b to 15af817 (27 revisions) (flutter/plugins#6837)
mauricioluz pushed a commit to mauricioluz/plugins that referenced this pull request Jan 26, 2023
…flutter#6631)

* Refactored Reaadme using code excerpts

* Fixes

* Updated Upstream and Fixed Test Errors

* Re-added temp_exclude_excerpt.yaml back due to Failing Test

* Restore deleted changelog entries

Co-authored-by: stuartmorgan <stuartmorgan@google.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App needs tests p: google_maps_flutter
Projects
None yet
3 participants