Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (61 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 2.15 KB

How to contribute

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

Before you begin

Getting Started

To set up your local development environment for contributing:

  1. Clone the repository:

    git clone https://github.com/google/adk-js.git
cd adk-js

  2. Install dependencies:

    npm install

  3. Build and test: Ensure everything is working correctly:

    npm run build
npm test

Code Quality

To maintain high code quality and consistency:

  1. Linting: Use ESLint to check for code quality issues.

    npm run lint

    To automatically fix some linting issues:

    npm run lint:fix

  2. Formatting: Use Prettier for consistent code styling.

    npm run format

The project uses husky and lint-staged to automatically lint and format your changes before each commit.

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.

PR policy

AI Generated code

It's ok to generate the first draft using AI but we would like code which has gone through human refinement.

TSDoc

We want our TSDocs to be concise and meaningful. Usually aligned with adk-python.