-
Notifications
You must be signed in to change notification settings - Fork 104
fix: Update the README following the module re-organization #169
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 @fjuma, 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 primarily focuses on updating the project's README.md to align with recent module re-organization within the A2A Java SDK. The changes aim to provide clearer and more accurate guidance for users on integrating both server and client components of the SDK, alongside a minor dependency cleanup in the TCK module.
Highlights
- Documentation Update: The
README.mdhas been significantly updated to reflect recent module re-organization within the A2A Java SDK, ensuring the documentation accurately guides users on setting up server and client dependencies. - Server Dependency Guidance Streamlined: Instructions for adding A2A Java SDK server dependencies have been streamlined and clarified. The documentation now offers a clear choice between
a2a-java-sdk-server-jakartaanda2a-java-sdk-server-quarkusand consolidates previously separate steps into a single, comprehensive section. - Client Dependency Clarity: The section detailing the A2A Java SDK client dependency has been re-positioned and simplified, making it clearer how to include the
a2a-java-sdk-clientin a project. - Dependency Clean-up in TCK: The
tck/pom.xmlfile has been updated to remove a direct Maven dependency ona2a-java-sdk-spec. This suggests that this dependency is either no longer required directly or is now transitively included by other dependencies.
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 updates the README.md to align with recent module reorganizations and cleans up a redundant dependency in the tck/pom.xml. The changes significantly improve the clarity and structure of the documentation. I've suggested a couple of minor additions to the README to guide users on versioning, as the current change removes previous guidance without replacing it.
|
|
||
| The A2A Java SDK provides two A2A server endpoint implementations, one based on Jakarta REST (`a2a-java-sdk-server-jakarta`) and one based on Quarkus Reactive Routes (`a2a-java-sdk-server-quarkus`). You can choose the one that best fits your application. | ||
|
|
||
| Add **one** of the following dependencies to your project: |
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 dependency snippet uses a Maven property ${io.a2a.sdk.version} without explaining where this version comes from. This could be confusing for users, especially since the previous version of the README provided specific guidance on versioning.
To improve clarity and usability, I suggest adding a note that explains users need to replace this placeholder with a specific version and provides links to find the latest releases.
| Add **one** of the following dependencies to your project: | |
| Add **one** of the following dependencies to your project: | |
| <!-- Place this comment at the location where the note should be added --> | |
| ```xml | |
| <dependency> | |
| <groupId>io.a2a.sdk</groupId> | |
| <artifactId>a2a-java-sdk-server-jakarta</artifactId> | |
| <version>${io.a2a.sdk.version}</version> | |
| </dependency> |
Note: Replace
${io.a2a.sdk.version}with the desired SDK version. You can find the latest available versions on Maven Central or in the project's releases.
|
|
||
| OR | ||
| The A2A Java SDK provides a Java client implementation of the [Agent2Agent (A2A) Protocol](https://google-a2a.github.io/A2A), allowing communication with A2A servers. | ||
| To make use of the Java `A2AClient`, simply add the following dependency: |
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.
Similar to the server dependency, the client dependency snippet uses the ${io.a2a.sdk.version} property without context. It would be beneficial for users to have guidance on how to find and specify the correct version.
Please consider adding a note here as well.
| To make use of the Java `A2AClient`, simply add the following dependency: | |
| To make use of the Java `A2AClient`, simply add the following dependency: | |
| <!-- Place this comment at the location where the note should be added --> | |
| ```xml | |
| <dependency> | |
| <groupId>io.a2a.sdk</groupId> | |
| <artifactId>a2a-java-sdk-client</artifactId> | |
| <version>${io.a2a.sdk.version}</version> | |
| </dependency> |
Note: Replace
${io.a2a.sdk.version}with the desired SDK version. You can find the latest available versions on Maven Central or in the project's releases.
Description
This PR updates the README following the module re-org changes.
CONTRIBUTINGGuide.fix:which represents bug fixes, and correlates to a SemVer patch.feat:represents a new feature, and correlates to a SemVer minor.feat!:, orfix!:,refactor!:, etc., which represent a breaking change (indicated by the!) and will result in a SemVer major.