fix(contributing): Fix readme reference#4450
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @blazingbbq, 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 important documentation fix by updating the CONTRIBUTING.md file. It ensures that the link pointing to the project's main README file uses the correct .rst extension instead of the old .md extension. This change improves the accuracy of the contribution guidelines and helps new contributors navigate the project's documentation more effectively.
Highlights
- Documentation Update: The pull request updates an outdated reference within the
CONTRIBUTING.mdfile. - Corrected File Extension: The reference to the
READMEfile has been corrected from.mdto.rst, reflecting the current file format.
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 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. ↩
65607fb to
4dae895
Compare
There was a problem hiding this comment.
Code Review
This pull request correctly fixes a broken link in CONTRIBUTING.md, updating the reference from README.md to README.rst. The change is accurate and also includes minor whitespace cleanup. I've added a suggestion to further improve the file by using relative links for repository-local paths, which will make the documentation more robust when viewed in forks or local clones.
What type of PR is this?
Documentation
What does this PR do? Why is it needed?
Fixes Contributing.md reference to README. The file is no longer a
.mdfile, it is now a.rstfile.Which issues(s) does this PR fix?
Fixes #
Other notes for review
None.