Add link to contribution guidelines in README #2193#2215
Add link to contribution guidelines in README #2193#2215jcstein merged 2 commits intocelestiaorg:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @Abhishek-singh88, 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 project's documentation by integrating a direct, clickable link to the external contribution guidelines within the README.md file. This change improves the discoverability of contribution instructions for potential contributors, directly addressing the request made in issue #2193.
Highlights
- Documentation: Added a direct hyperlink to the "External Contributions" section of the project's contribution guidelines within the
README.mdfile.
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 correctly adds a link to the external contribution guidelines in the README.md file, which improves clarity for contributors. I've added one suggestion to align the text with the project's own documentation standards, specifically regarding the use of polite phrasing.
jcstein
left a comment
jcstein
left a comment
There was a problem hiding this comment.
lgtm, thank you @Abhishek-singh88
2 participants
Summary
This PR adds a link to the external contribution guidelines in the README.md file, as requested in issue #2193. It directs users to the "External Contributions" section for detailed instructions.
Related Issue
Closes #2193