-
Notifications
You must be signed in to change notification settings - Fork 5.2k
docs(README): call out JDK 17 requirement for AGP #1609
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?
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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 @Qandil11, 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 project's documentation by adding a crucial detail about the required Java Development Kit (JDK) version. The update directly addresses a frequent issue faced by new contributors, ensuring they have the necessary information to successfully build the project from the outset.
Highlights
- Documentation Update: Added a clear note to the README.md file specifying the JDK 17 requirement for building projects that use recent Android Gradle Plugin (AGP) versions.
- Developer Experience Improvement: This change aims to prevent common build errors encountered by new contributors, streamlining their setup process and reducing initial friction.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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 adds a helpful note to the README.md
file, clarifying the JDK 17 requirement for recent Android Gradle Plugin versions. This is a great addition for new contributors. I've included a couple of minor suggestions to improve the formatting and readability of the new section.
README.md
Outdated
> **Java / JDK** | ||
> Building with recent Android Gradle Plugin versions requires **JDK 17**. | ||
> Android Studio (Flamingo and newer) bundles JDK 17 by default. | ||
> See: https://developer.android.com/studio/releases/gradle-plugin#jdk-17 |
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.
For better readability and to provide more context, it's a good practice to use descriptive text for links instead of raw URLs.
> See: https://developer.android.com/studio/releases/gradle-plugin#jdk-17 | |
> See the [AGP release notes](https://developer.android.com/studio/releases/gradle-plugin#jdk-17). |
> Android Studio (Flamingo and newer) bundles JDK 17 by default. | ||
> See: https://developer.android.com/studio/releases/gradle-plugin#jdk-17 | ||
|
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.
New contributors often hit “AGP requires Java 17” when building samples.
This adds a short note under Requirements with a link to the official AGP docs.