chore(docs): Remove Google references from contributing guide#262
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @holtskinner, 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 refines the project's CONTRIBUTING.md guide by removing all Google-specific references and internal instructions. The aim is to make the contribution process more universal and accessible to a wider audience of contributors, ensuring the documentation is relevant to everyone.
Highlights
- Documentation Generalization: Removed the 'Before you begin' section from
CONTRIBUTING.md, which previously referenced Google's Open Source Community Guidelines. This change broadens the applicability of the contribution guide. - Internal Process Removal: Eliminated the 'For Google Employees' section from
CONTRIBUTING.md, which contained internal instructions and links specific to Google employees. This further generalizes the guide for all contributors.
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 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 removes Google-specific references from the CONTRIBUTING.md file, which is a good step towards making the project's documentation more generic. My review includes one suggestion to re-introduce a link to the project's CODE_OF_CONDUCT.md, as the original link was removed along with the Google-specific section. As a potential follow-up, you may also want to review CODE_OF_CONDUCT.md itself for any remaining Google-specific text to fully complete this effort.
| We'd love to accept your patches and contributions to this project. | ||
|
|
There was a problem hiding this comment.
Thanks for removing the Google-specific references. While this is the right direction, removing the entire 'Before you begin' section means the contributing guide no longer points to any code of conduct. It's important for contributors to be aware of the project's community standards.
I suggest adding back a section that links to the project's CODE_OF_CONDUCT.md file to ensure it remains discoverable.
| We'd love to accept your patches and contributions to this project. | |
| We'd love to accept your patches and contributions to this project. | |
| ## Code of Conduct | |
| This project has a [Code of Conduct](CODE_OF_CONDUCT.md) that all contributors are expected to follow. Please read it before contributing. | |
Removed sections about the Contributor License Agreement and Google employee contribution steps. Mirrors a2aproject/a2a-python#262 and resolves #110 Fixes #110 🦕
Fixes #250 🦕