-
Couldn't load subscription status.
- Fork 1.5k
[firebaseai] Rename FirebaseAIExample to FirebaseAISample and update README #1712
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @YoungHypo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the clarity and usability of the firebaseai project. It addresses a minor but important naming inconsistency by standardizing the project and bundle identifier from 'Example' to 'Sample', and significantly improves the project's setup documentation by including a vital step for enabling Gemini APIs.
Highlights
- Naming Consistency: Renamed all occurrences of
FirebaseAIExampletoFirebaseAISampleacross the Xcode project files and documentation to correct a typo and ensure consistent naming for the sample application. - Documentation Update: Added a new step to the
README.mdproviding crucial instructions on how to enable Gemini Developer API and Vertex AI Gemini API in the Firebase Console, improving the setup experience for new users.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request renames FirebaseAIExample to FirebaseAISample to improve naming consistency and updates the README with instructions for enabling Gemini APIs. The changes are well-executed and enhance the user experience.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@YoungHypo thanks for the PR to improve the consistency of the Samples. The CI scripts will also have to be updated to run correctly. |
|
On second thought, "Example" is consistent with the rest of the quickstarts in this repo. So I don't think we want to proceed with this. I'll close, but welcome to continue the conversation here. |
I agree with @paulb777 though we could change everything to |
|
Totally agree. If you think it’s necessary, I'd love to rename all instances of |
|
Making it consistent would be a good improvement, so we'd be happy to review a PR. |
FirebaseAIExampletoFirebaseAISampleto fix a naming inconsistency. TheFirebaseAIExampleappears to be a typo, shoule beFirebaseAISample.