Add CONTRIBUTING.md

[dpasiukevich]

Once it's merged I will update https://google.github.io/adk-docs/contributing-guide/#how-to-contribute

[gemini-code-assist]

Summary of Changes

Hello @dpasiukevich, I'm Gemini Code Assist¹! 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 introduces a new CONTRIBUTING.md file, establishing clear and comprehensive guidelines for external contributions to the project. The document aims to standardize the contribution process by detailing expectations for code quality, testing, documentation, and overall workflow, ensuring consistency and maintainability across the codebase.

Highlights

• New Contribution Guidelines: A new CONTRIBUTING.md file has been added to the repository, providing comprehensive guidelines for external contributors.
• Contributor License Agreement (CLA): The document clarifies the requirement for signing a Contributor License Agreement (CLA) for all contributions, linking to Google's CLA page.
• Contribution Workflow and Requirements: Detailed sections outline the contribution workflow, including how to find issues, requirements for Pull Requests (e.g., linking issues, small PRs, testing plans), and guidance for large or complex changes.
• Testing and Documentation Standards: Specific requirements for unit tests and manual End-to-End (E2E) tests are provided, along with instructions for updating user-facing documentation in the adk-docs repository.

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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request introduces a CONTRIBUTING.md file, which is an excellent addition to guide new contributors. The document is well-structured and covers the key aspects of the contribution process. My feedback includes several minor suggestions to improve grammar, formatting consistency, and clarity, ensuring the guide is as easy to follow as possible. Overall, this is a valuable contribution to the project.