Skip to content

docs(auth): add missing import statement for google sign-in#2946

Merged
Salakar merged 1 commit into
firebase:masterfrom
palcodes:patch-1
Jul 13, 2020
Merged

docs(auth): add missing import statement for google sign-in#2946
Salakar merged 1 commit into
firebase:masterfrom
palcodes:patch-1

Conversation

@palcodes

@palcodes palcodes commented Jul 13, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

The google_sign_in package from pub.dev/packages/google_sign_in is being used but no import statement is mentioned for the same in the README. And it is mandatory to import the google_sign_in package for creating an instance of GoogleSignIn i.e. working with Google Authentication.

Description

  • This PR simply places an import statement for the package - google_sign_in.
  • Beginners might come across the documentation and be confused as to what else is needed to import for Google auth.
  • This slightly makes it insightful for the document reader that he/she needs to import the google_sign_in package from pub.dev [link provided above].
  • In fact the firebase_auth documentation for auth does mention using the plugin to implement Google authentication, but the section Use The Plugin is a bit misleading for a newcomer.

Related Issues

Replace this paragraph with a list of issues related to this PR from the issue database. Indicate, which of these issues are resolved or fixed by this PR. Note that you'll have to prefix the issue numbers with flutter/flutter#.

Checklist

Before you create this PR confirms that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • If the pull request affects only one plugin, the PR title starts with the name of the plugin in brackets (e.g. [cloud_firestore])
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate a breaking change in CHANGELOG.md and increment major revision).
  • No, this is not a breaking change.

@palcodes
Added the import statement for Google SignIn
833f83a 
The google_sign_in package from [ https://pub.dev/packages/google_sign_in ] is being used but no import statement is mentioned for the same.
And importing the package is required for creating an instance of GoogleSignIn.
@googlebot

googlebot commented Jul 13, 2020

Copy link
Copy Markdown

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@palcodes

palcodes commented Jul 13, 2020

Copy link
Copy Markdown
Contributor Author

@googlebot I signed it!

@googlebot

googlebot commented Jul 13, 2020

Copy link
Copy Markdown

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@Salakar Salakar changed the title [auth] Add the import statement for Google Sign In in firebase_auth Docs docs(auth): add missing import statement for google sign-in Jul 13, 2020
@Salakar Salakar merged commit 481d466 into firebase:master Jul 13, 2020
@Salakar

Salakar commented Jul 13, 2020

Copy link
Copy Markdown
Contributor

Thank you :)

@palcodes

palcodes commented Jul 13, 2020

Copy link
Copy Markdown
Contributor Author

Hey, @Salakar thanks for approving 😊
This change is minor but does help in providing a context to the reader that he/she needs to use the specified package, considering the snippet of code just before and after the import line, requires google_sign_in to be imported.
Looking forward to making more contributions as I learn.

@firebase firebase locked and limited conversation to collaborators Aug 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@Salakar Salakar Salakar approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@palcodes @googlebot @Salakar