How to contribute

August 15, 2025 · View on GitHub

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.

PR policy

Format

Code must be formatted according to the Google Java Style Guide.

The Maven build will automagically run google-java-format when you locally build this project.

Pull requests will fail to build if you forget to commit reformatted code, and cannot be merged until you fix this.

Single Commit

Pull Requests must contain only a single commit.

This is due to how Google replicates this Git repository both into and from its internal monorepo (see Wikipedia and Paper) with 🦛 Copybara.

When adjusting a PR to code review feedback, please use git commit --amend.

You can use git rebase -i main to meld/squash existing commits into one.

Then use git push --force-with-lease to update the branch of your PR.

We cannot merge your PR until you fix this.