Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (35 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

58 lines (35 loc) · 2.36 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Branching Strategy

To maintain a stable release history, this repository follows a specific branching workflow:

main: Contains the latest stable release. This branch is only updated during a new release cycle.

develop: The active development branch. All new features, bug fixes, and community contributions are merged here first.

Important: All Pull Requests must be targeted at the develop branch. PRs targeting main will be closed or redirected.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.

A maintainer will review the pull request once the following conditions are met:

  1. All pre-commit checks must pass successfully.

  2. Any merge conflicts with the target branch must be resolved.

  3. All valid feedback and suggestions generated by Gemini Code Assist must be addressed by the author.

  4. Ensure unit tests are implemented to improve coverage where applicable.

  5. Whenever a new blueprint or module is added, explicitly outline a test plan for the maintainers to create integration tests.

  6. New partner or experimental modules should be submitted to the 'community/modules/' directory only.

  7. Ensure any new modules are listed in modules/README.md, and new blueprints are listed in examples/README.md.

Consult GitHub Help for more information on pull requests.

Standard PR Response Times

Community submissions can take up to 2 weeks to be reviewed.

Community Guidelines

This project follows Google's Open Source Community Guidelines.