Skip to content

Clean up README.md by removing unnecessary sections - #29138

Open
MNsharahily wants to merge 2 commits into
google-gemini:mainfrom
MNsharahily:patch-1
Open

Clean up README.md by removing unnecessary sections#29138
MNsharahily wants to merge 2 commits into
google-gemini:mainfrom
MNsharahily:patch-1

Conversation

@MNsharahily

Copy link
Copy Markdown

Removed extensive content from README.md, including badges, installation instructions, features, and usage examples.

Summary

Details

Related Issues

How to Validate

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

Removed extensive content from README.md, including badges, installation instructions, features, and usage examples.
@MNsharahily
MNsharahily requested review from a team as code owners August 31, 2026 01:16
@google-cla

google-cla Bot commented Aug 31, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 performs a significant cleanup of the project's README.md file. By removing redundant or overly verbose sections such as installation guides, feature highlights, and external badges, the documentation is now more concise and focused.

Highlights

  • README Cleanup: Removed extensive content from the README.md file, including badges, installation instructions, feature lists, and usage examples to simplify the project documentation.
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 the 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 counterproductive. 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

  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.

@github-actions github-actions Bot added the size/l A large sized PR label Aug 31, 2026
@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown

📊 PR Size: size/L

  • Lines changed: 412
  • Additions: +0
  • Deletions: -412
  • Files changed: 1

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 completely empties the README.md file. The reviewer correctly points out that removing the entire README is problematic as it serves as the repository's primary landing page. They suggest retaining at least the project title, a brief description, and a link to the official documentation.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread README.md Outdated
@@ -1,412 +1 @@
# Gemini CLI

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Completely emptying the README.md file removes the repository's primary landing page, which is critical for users discovering the project. While cleaning up extensive sections is reasonable, the README should at least retain the project title, a brief description, and a link to the official documentation.

Suggested change
# Gemini CLI
Gemini CLI is an open-source AI agent that brings the power of Gemini directly into your terminal.
Learn all about Gemini CLI in our [documentation](https://geminicli.com/docs/).

@gemini-cli gemini-cli Bot added the priority/p1 Important and should be addressed in the near term. label Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority/p1 Important and should be addressed in the near term. size/l A large sized PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant