-
Notifications
You must be signed in to change notification settings - Fork 76
docs: fix SendMessageSuccessResponse import in example #126
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
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 @Areo-Joe, 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 addresses a documentation issue by fixing an incorrect import path in the README.md
file. The change ensures that the example code provided in the documentation is accurate and functional, improving the clarity and usability for anyone referencing the project's documentation.
Highlights
- Documentation Fix: Corrected the import path for SendMessageSuccessResponse within the README.md file's TypeScript example.
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 PR correctly fixes an import path in a documentation example. I've added one comment pointing out another location in the file where the same fix is needed for consistency.
/gemini review |
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 correctly fixes the import path for SendMessageSuccessResponse
in the documentation examples, moving it from @a2a-js/sdk/client
to @a2a-js/sdk
. The change is accurate and improves the correctness of the examples. I've added one minor suggestion to sort the named imports in one of the examples for better code consistency.
import { A2AClient, SendMessageSuccessResponse } from "@a2a-js/sdk/client"; | ||
import { Message, MessageSendParams, Task } from "@a2a-js/sdk"; | ||
import { A2AClient } from "@a2a-js/sdk/client"; | ||
import { Message, MessageSendParams, Task, SendMessageSuccessResponse } from "@a2a-js/sdk"; |
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 improved code consistency and readability, it's a good practice to sort named imports alphabetically.1 In this case, SendMessageSuccessResponse
should come before Task
.
import { Message, MessageSendParams, Task, SendMessageSuccessResponse } from "@a2a-js/sdk"; | |
import { Message, MessageSendParams, SendMessageSuccessResponse, Task } from "@a2a-js/sdk"; |
Style Guide References
Footnotes
-
Many style guides, including common ESLint configurations, recommend sorting named imports alphabetically to improve code readability and maintainability by making it easier to find specific imports. ↩
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTING
Guide.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.Fix the
SendMessageSuccessResponse
import in README.