-
Notifications
You must be signed in to change notification settings - Fork 9.3k
docs(ide): define diffing interface for companion extension spec #8479
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 @skeshive, 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 significantly enhances the Gemini CLI's IDE companion specification by formally introducing a "Diffing Interface." This crucial addition allows IDE extensions to provide native, interactive diffing experiences for code modifications proposed by the Gemini CLI, empowering users to review, edit, and manage changes directly within their preferred development environment. It formalizes the communication protocol for opening, closing, accepting, and rejecting diffs.
Highlights
- New Diffing Interface: A new "Diffing Interface" has been formally defined in the IDE companion specification, enabling IDE extensions to offer native, interactive diffing capabilities for code changes suggested by the Gemini CLI.
- Interactive Diffing Tools: The specification now includes detailed definitions for
openDiffandcloseDifftools, which allow the CLI to request the IDE to open or close a modifiable diff view. - Diff Outcome Notifications: New
ide/diffAcceptedandide/diffRejectednotifications have been added, allowing the IDE extension to asynchronously communicate the user's decision regarding proposed changes back to the CLI. - Document Update Timestamp: The
ide-companion-spec.mddocument now includes a "Last Updated" timestamp for better version tracking.
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 introduces the specification for a new, optional "Diffing Interface" in the IDE companion extension. My review focuses on ensuring the new specification is clear, consistent, and accurately reflects the implementation details provided in the context files. I've identified a few critical discrepancies and ambiguities in the documentation for the closeDiff tool and its related notifications. Addressing these will improve the specification's correctness and prevent potential issues for developers implementing this interface.
|
Size Change: -2 B (0%) Total Size: 13.6 MB ℹ️ View Unchanged
|
Code Coverage Summary
CLI Package - Full Text ReportCore Package - Full Text ReportFor detailed HTML reports, please see the 'coverage-reports-22.x-ubuntu-latest' artifact from the main CI run. |
…nion extension spec (google-gemini#8479)
TLDR
This PR updates the IDE companion specification (
docs/ide-companion-spec.md) to formally define the "Diffing Interface." This new, optional interface allows an IDE extension to provide native, interactive diffing for code changes proposed by Gemini CLI.Linked issues / bugs
#4800