docs: fix typos and improve clarity in README#25200
docs: fix typos and improve clarity in README#25200Guru6446 wants to merge 1 commit intogoogle-gemini:mainfrom
Conversation
- Fixed spelling errors - Improved formatting - Enhanced clarity of instructions
Summary of ChangesHello, 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 exclusively on improving the quality and accuracy of the project's documentation. By refining existing text and removing outdated elements, the changes ensure that the README remains a reliable and clear resource for users. Highlights
Using Gemini Code AssistThe 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
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 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request removes the Code Wiki badge and updates several links and descriptions in the README. However, the edits to the 'IDE Integration' and 'License' sections inadvertently deleted the 'Sandboxing & Security' and 'Terms of Service' headers, resulting in duplicate entries and orphaned descriptions that need to be restored.
Note: Security Review has been skipped due to the limited scope of the PR.
| - [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS | ||
| Code companion. | ||
| - [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe | ||
| - [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion. | ||
| execution environments. |
There was a problem hiding this comment.
The update to the 'IDE Integration' description has accidentally overwritten the 'Sandboxing & Security' section header and duplicated the 'IDE Integration' entry. This results in broken documentation where the sandboxing description is orphaned. Please maintain consistency in documentation as per the repository guidelines.
| - [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - VS | |
| Code companion. | |
| - [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe | |
| - [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion. | |
| execution environments. | |
| - [**IDE Integration**](https://www.geminicli.com/docs/ide-integration) - Visual Studio Code companion. | |
| - [**Sandboxing & Security**](https://www.geminicli.com/docs/cli/sandbox) - Safe | |
| execution environments. |
References
- Maintain consistency in documentation. When information about a feature is present in multiple documents, ensure all instances are updated or removed together to avoid contradictions.
| - **License**: [Apache License 2.0](LICENSE) | ||
| - **Terms of Service**: | ||
| - **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE) | ||
| [Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy) |
There was a problem hiding this comment.
The 'Terms of Service' label was replaced by a duplicate 'License' entry. This causes the 'Terms & Privacy' link to be incorrectly associated and creates redundant information. Please maintain consistency in documentation as per the repository guidelines.
| - **License**: [Apache License 2.0](LICENSE) | |
| - **Terms of Service**: | |
| - **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE) | |
| [Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy) | |
| - **License**: [Apache License 2.0](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE) | |
| - **Terms of Service**: | |
| [Terms & Privacy](https://www.geminicli.com/docs/resources/tos-privacy) |
References
- Maintain consistency in documentation. When information about a feature is present in multiple documents, ensure all instances are updated or removed together to avoid contradictions.
|
Hi there! Thank you for your interest in contributing to Gemini CLI. To ensure we maintain high code quality and focus on our prioritized roadmap, we have updated our contribution policy (see Discussion #17383). We only guarantee review and consideration of pull requests for issues that are explicitly labeled as 'help wanted'. All other community pull requests are subject to closure after 14 days if they do not align with our current focus areas. For this reason, we strongly recommend that contributors only submit pull requests against issues explicitly labeled as 'help-wanted'. This pull request is being closed as it has been open for 14 days without a 'help wanted' designation. We encourage you to find and contribute to existing 'help wanted' issues in our backlog! Thank you for your understanding and for being part of our community! |
Description
Fixed typos and improved clarity in the README documentation.
Changes
Type of Change
This is a documentation-only change with no code modifications.