Update README.md #7462
Update README.md #7462
Conversation
Change the Installation Line command box for better user experience and easy to copy and execute command then previously when copied text had the extra comment included which made the command throw error
There was a problem hiding this comment.
Summary of Changes
Hello @harshityadav95, 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 impactful usability issue in the README.md by refining the presentation of the npx installation command. The change aims to streamline the user experience, making it easier for new users to get started without encountering common copy-paste errors.
Highlights
- Improved
npxcommand usability: Thenpxinstallation command inREADME.mdhas been updated to prevent copy-paste errors caused by an inline comment. The comment is now on a separate line, ensuring only the command is copied.
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 updates the README.md to fix an issue with the npx installation command. By moving the comment outside of the code block, you've resolved a copy-paste issue for users, which is a great improvement to the user experience. The change is correct and well-explained. I have no further suggestions.
|
/gemini review |
|
/gemini summary |
There was a problem hiding this comment.
Code Review
This pull request successfully fixes a copy-paste issue with the npx command in the README.md by moving the comment outside the code block. This is a good improvement for user experience. However, I've identified a significant improvement we can make to the npx command itself. Currently, it points to the GitHub repository, which runs the code from the main branch. This can be unstable and is not ideal for a "Quick Install" guide. I've suggested changing it to point to the stable version on npm, which will provide a more reliable experience for new users.
Summary of ChangesThis pull request focuses on enhancing the user experience for new users by refining the installation instructions. It addresses a common pitfall where copying a command directly from the documentation could lead to execution errors, thereby streamlining the initial setup process. Highlights
Changelog
Activity
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Thank you for your contribution. This will change npx to pull the latest version from NPM rather than from HEAD. Did you intentionally change that? |
TLDR
This PR updates the
npxinstallation command in theREADME.mdto improve user experience. The previous format, which included an inline comment, often caused an error when the command was copied and pasted.Dive Deeper
The original
README.mdhad thenpxcommand and a comment on the same line within a single code block. When users copied this, the comment text would be included, making the command invalid and causing it to fail. This change separates the command from the comment, placing the comment on its own line above the code block. This ensures that only the commandnpx https://github.com/google-gemini/gemini-cliis copied, allowing for a seamless and error-free installation process.Reviewer Test Plan
README.mdfile and navigate to the "Using npx" section.gemini-clishould start as expected.Testing Matrix