Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.69 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). 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.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our community guidelines

This project follows Google's Open Source Community Guidelines.

Contribution process

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Setup

Note: If you want to setup all runtime environments at the same time (js/go/py), you may want to run the bin/setup script. Beware, this script may break other setup you may already have in your project environment.

Genkit supports JavaScript, Go, and Python. Before contributing in any of these languages, complete these prerequisites:

  1. Install Node.js 20 or later using nvm

    Note: Node.js v20 or greater is required. Earlier versions may not work properly.

  2. Install the Genkit CLI globally:

    npm install -g genkit-cli