docs: update README#206
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @16bit-ykiko, 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 focuses on minor but important updates to the README.md file. The primary goal is to enhance the accuracy of code block syntax highlighting for a JSON configuration example by changing its language specifier to jsonc, which correctly handles comments. Additionally, it addresses a file formatting detail by ensuring the README.md file ends with a newline character.
Highlights
- Documentation Improvement: Updated the language specifier for a JSON code block in
README.mdfromjsontojsoncto correctly indicate support for comments within the JSON configuration example. - File Formatting: Ensured the
README.mdfile terminates with a newline character, adhering to common file formatting best practices.
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.
Code Review
This pull request introduces two beneficial updates to the README.md file. The first change updates a code block's language identifier from json to jsonc. This is a correct change as the JSON snippet contains comments, and jsonc (JSON with Comments) is the appropriate identifier, which will also improve syntax highlighting. The second change adds a newline at the end of the file, adhering to common best practices for text files. Both modifications are positive improvements to the documentation.
No description provided.