-
Couldn't load subscription status.
- Fork 1.5k
Rename FirebaseAISample to FirebaseAIExample and update README #1716
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 consistency and clarity within the Firebase AI quickstart project by performing a comprehensive rename from 'Sample' to 'Example'. This change affects file paths, Xcode project configurations, in-code references, and user-facing documentation, ensuring a unified and accurate terminology throughout the repository.
Highlights
- Project-wide Renaming: The core change involves renaming all occurrences of
FirebaseAISampletoFirebaseAIExampleacross the project. This includes updating directory names, Xcode project file references (project.pbxproj), and build scheme configurations (.xcscheme). - Codebase Consistency: Internal code references, such as
navigationTitlevalues in various SwiftUI views (e.g.,ConversationScreen,ErrorView,MessageView,PhotoReasoningScreen,GenerateContentScreen,ImagenScreen), and the main application struct (FirebaseAISampleApp), have been updated from using 'sample' to 'example' for improved clarity and consistency. - Documentation Updates: The
README.mdfile has been revised to reflect the new project name, update the instructions for opening the Xcode project, and add a crucial step for enabling the necessary Gemini Developer API and Vertex AI Gemini API in the Firebase Console.
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
The pull request renames FirebaseAISample to FirebaseAIExample for consistency across the project. The changes include updates to file names, project configurations, and documentation. The README has been updated with instructions to enable the Gemini API.
firebaseai/GenerativeAIMultimodalExample/Screens/PhotoReasoningScreen.swift
Show resolved
Hide resolved
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.
LGTM, please address the suggestions Gemini made and which I thumbed-up.
Renamed all occurrences from
FirebaseAISampletoFirebaseAIExampleto fix a naming inconsistency, including file names, READE.md, and corresponding references in the code. The project files now are structured as follows.