-
-
Notifications
You must be signed in to change notification settings - Fork 366
docs(readme): add a used by section #326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @gouravkhunger, 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 enhances the README by adding a dedicated section that highlights the repository's usage by other projects. It leverages the dependents.info service to provide dynamic badges and images showing the dependent count and network.
Highlights
- Add 'Used by' section: Introduced a new section in the README to showcase projects that depend on this repository.
- Integrate dependents.info: Added a badge and a visual image from dependents.info to display the number and network of dependents.
- Update Table of Contents: Added a link to the new 'Used by' section in the README's Table of Contents for easier navigation.
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 is currently in preview and 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 to provide feedback.
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 configureGemini 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.
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 introduces a 'Used by' section in the README.md, showcasing project dependents using badges and images from dependents.info. The changes enhance the README by providing visibility into the project's adoption. My review focuses on improving the accessibility of the newly added images by ensuring they have appropriate alternative text.
Hi there!
Thank you for this awesome project! This PR adds a beautiful "Used by" section in the
README.md
file to showcase its impact.I've created this using an open source tool I built myself: dependents.info. Here's a preview of how the image renders:
Used by
There's also a shield.io based badge if you prefer the smaller variant.
For your repository, they will look like this:
Please feel free to close the PR if you don't want to have this!