Skip to content

docs: Fix a bug in the example: preferredEditor: 'code' -> 'vscode'#14685

Closed
wanglc02 wants to merge 2 commits intogoogle-gemini:mainfrom
wanglc02:docBugFix
Closed

docs: Fix a bug in the example: preferredEditor: 'code' -> 'vscode'#14685
wanglc02 wants to merge 2 commits intogoogle-gemini:mainfrom
wanglc02:docBugFix

Conversation

@wanglc02
Copy link
Contributor

@wanglc02 wanglc02 commented Dec 7, 2025

Summary

This PR fixes a configuration error in the example JSON. It updates the preferredEditor value from "code" to "vscode" to ensure the setting works as expected.

Details

The value "code" was previously used in the example, but the correct identifier for Visual Studio Code in this context is "vscode". This change prevents potential confusion or errors for users copying this configuration.

How to Validate

  1. Check the diff to confirm only the preferredEditor value has changed.
  2. (Optional) If applying this configuration locally, verify that VS Code is correctly identified as the preferred editor.

Pre-Merge Checklist

  • Updated relevant documentation and README (if needed)
  • Added/updated tests (if needed)
  • Noted breaking changes (if any)
  • Validated on required platforms/methods:
    • MacOS
      • npm run
      • npx
      • Docker
      • Podman
      • Seatbelt
    • Windows
      • npm run
      • npx
      • Docker
    • Linux
      • npm run
      • npx
      • Docker

@wanglc02 wanglc02 requested a review from a team as a code owner December 7, 2025 13:24
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @wanglc02, 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 minor but important documentation correction by updating an example JSON configuration. The preferredEditor setting, which was previously set to an incorrect value of "code", has been changed to the proper identifier "vscode". This change ensures that the documentation provides accurate and functional examples for users.

Highlights

  • Configuration Example Fix: Corrected a configuration error within an example JSON snippet in the documentation.
  • Preferred Editor Value: Updated the preferredEditor value from "code" to "vscode" to accurately represent Visual Studio Code.
  • Documentation Accuracy: Ensures the example configuration is correct and functional, preventing potential confusion for users.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 addresses a minor but important error in the documentation's example configuration. The preferredEditor value has been corrected from "code" to "vscode", aligning the example with the application's actual implementation. This is a valuable fix that will prevent confusion and ensure users can correctly configure their preferred editor. The change is accurate and I approve it.

@gemini-cli gemini-cli bot added the status/need-issue Pull requests that need to have an associated issue. label Jan 7, 2026
@bdmorgan
Copy link
Collaborator

Hi @wanglc02, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

@sehoon38 sehoon38 requested a review from a team as a code owner January 21, 2026 04:12
@gemini-cli
Copy link
Contributor

gemini-cli bot commented Jan 24, 2026

Hi there! Thank you for your contribution to Gemini CLI.

To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md.

This pull request is being closed because it is not currently linked to an issue. You can easily reopen this PR once you have linked it to an issue.

How to link an issue:
Add a keyword followed by the issue number (e.g., Fixes #123) in the description of your pull request. For more details, see the GitHub Documentation.

Thank you for your understanding and for being a part of our community!

@gemini-cli gemini-cli bot closed this Jan 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status/need-issue Pull requests that need to have an associated issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants