Add support policy section to README #1
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @VirajAgarwal-couchbase, 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!
Summary of Changes
This pull request adds a 'Support Policy' section to the README.md file. The new section clarifies that the project is community-maintained and not officially supported by the support team. It directs users to open GitHub issues for help, bug reports, or contributions, and informs them that the support portal cannot assist with requests related to the project.
Highlights
- New Section: A 'Support Policy' section has been added to the README.md file.
- Community Maintained: The project is clarified as community-maintained and not officially supported.
- Issue Reporting: Users are directed to open GitHub issues for support, bug reports, and contributions.
Changelog
- README.md
- Added a 'Support Policy' section to clarify the support model for the project.
- The new section explains that the project is community-maintained.
- The new section directs users to GitHub issues for support and contributions.
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.
A README's tale,
Support policy to unveil,
Community's call.
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 adds a support policy section to the README file, clarifying that the project is community-maintained and directing users to GitHub issues for support. The addition is clear and helpful for users.
Merge Readiness
The changes are straightforward and improve the README by clarifying the support policy. The pull request is ready to be merged. I am unable to directly approve the pull request, and users should have others review and approve this code before merging.
No description provided.