-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Update README.md #1576
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
base: main
Are you sure you want to change the base?
Update README.md #1576
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 @MagicalMeghan, 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 enhances the README.md
for the Jetcaster sample application, providing additional context and guidance for users. The updates clarify key design aspects, specifically the use of Material Expressive elements and the app's primary dark theme, aiming to improve the initial user experience and understanding of the sample.
Highlights
- README Update: The
README.md
has been updated to highlight that the Jetcaster sample also showcases 'Material Expressive elements'. - Usage Guidance: New instructions have been added to the
README.md
advising users to set their device to dark theme when trying out the Jetcaster app. This section also explains the design rationale behind the app's primary dark theme, emphasizing its benefits for media apps and its ability to honor contrast and expressive design.
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 PR updates the README.md to provide more context about Jetcaster's features, specifically highlighting its use of Material Expressive elements and strongly recommending the use of dark theme for an optimal experience.
The additions are generally clear and informative. One suggestion has been made to refine the wording regarding the dark theme to ensure clarity about how the app's theming behaves in relation to system settings, while still encouraging users to try the dark theme for the best showcase.
showcase building with Compose across multiple form factors (mobile, TV, and Wear) and full featured architecture. | ||
showcase building with Compose across multiple form factors (mobile, TV, and Wear) and full featured architecture. This sample also showcases Material Expressive elements. | ||
|
||
Set your device to dark theme when trying out Jetcaster. This app features a dark theme as the primary theme of the app, since contextually media apps benefit greatly from dark themes. It also shows that contrast and expressive design can still be honored with dark themes. |
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.
The statement 'This app features a dark theme as the primary theme of the app' could be slightly clarified. While the strong recommendation to use dark theme is excellent for guiding users to the intended showcase experience, 'primary theme' might imply that the app always defaults to dark or that its light theme is significantly less supported. However, the theming code (e.g., in mobile/.../Theme.kt
) respects the system's current setting via isSystemInDarkTheme()
.
To enhance clarity and align perfectly with the app's behavior while still emphasizing the dark theme, consider a slight rephrasing. This helps ensure users on light-themed systems understand why dark theme is recommended if the app initially respects their light system theme.
Set your device to dark theme when trying out Jetcaster. This app features a dark theme as the primary theme of the app, since contextually media apps benefit greatly from dark themes. It also shows that contrast and expressive design can still be honored with dark themes. | |
Set your device to dark theme when trying out Jetcaster. Jetcaster's design is best showcased in its dark theme, which is why we recommend this setting; media apps contextually benefit greatly from dark themes. It also shows that contrast and expressive design can still be honored with dark themes. |
No description provided.