How to contribute
Stay organized with collections
Save and categorize content based on your preferences.
We'd love to accept your patches and contributions to this project. There are
a just a few small guidelines you need to follow.
Contributor License Agreement
Contributions to any Google project must be accompanied by a Contributor License Agreement. This is
not a copyright assignment, it simply gives Google permission to use and redistribute your
contributions as part of the project.
If you are an individual writing original source code and you're sure you own the intellectual
property, then you'll need to sign an individual CLA.
If you work for a company that wants to allow you to contribute your work, then you'll need to
sign a corporate CLA.
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.
Submitting a patch
It's generally best to start by opening a new issue describing the bug or feature you're
intending to fix. Even if you think it's relatively minor, it's helpful to know what people are
working on. Mention in the initial issue that you are planning to work on that bug or feature so
that it can be assigned to you.
Follow the normal process of forking the project,
and setup a new branch to work in. It's important that each group of changes be done in separate
branches in order to ensure that a pull request only includes the commits related to that bug or
feature.
Any significant changes should almost always be accompanied by tests. The project already has
good test coverage, so look at some of the existing tests if you're unsure how to go about it.
Do your best to have well-formed commit messages for each change. This
provides consistency throughout the project, and ensures that commit messages are able to be
formatted properly by various git tools.
Finally, push the commits to your fork and submit a pull request.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-10 UTC."],[[["\u003cp\u003eContribute to the project by following the guidelines and signing a Contributor License Agreement (CLA) if you haven't already.\u003c/p\u003e\n"],["\u003cp\u003eBefore submitting code changes, open an issue to discuss the bug or feature and create a new branch for your work.\u003c/p\u003e\n"],["\u003cp\u003eEnsure your contributions include tests, well-formatted commit messages, and are submitted as a pull request.\u003c/p\u003e\n"]]],["Contributors must sign a Contributor License Agreement (CLA), either individual or corporate, granting Google usage rights. To submit a patch, first open an issue describing the bug/feature and claim it. Then, fork the project, work in a new branch, and include tests for significant changes. Use well-formed commit messages. Finally, push commits to the fork and submit a pull request. Separate branches for distinct groups of changes are crucial.\n"],null,["# How to contribute\n\nWe'd love to accept your patches and contributions to this project. There are\na just a few small guidelines you need to follow.\n\nContributor License Agreement\n-----------------------------\n\nContributions to any Google project must be accompanied by a Contributor License Agreement. This is\nnot a copyright **assignment**, it simply gives Google permission to use and redistribute your\ncontributions as part of the project.\n\n- If you are an individual writing original source code and you're sure you own the intellectual\n property, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).\n\n- If you work for a company that wants to allow you to contribute your work, then you'll need to\n sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).\n\nYou generally only need to submit a CLA once, so if you've already submitted one (even if it was for\na different project), you probably don't need to do it again.\n\nSubmitting a patch\n------------------\n\n1. It's generally best to start by opening a new issue describing the bug or feature you're\n intending to fix. Even if you think it's relatively minor, it's helpful to know what people are\n working on. Mention in the initial issue that you are planning to work on that bug or feature so\n that it can be assigned to you.\n\n2. Follow the normal process of [forking](https://help.github.com/articles/fork-a-repo) the project,\n and setup a new branch to work in. It's important that each group of changes be done in separate\n branches in order to ensure that a pull request only includes the commits related to that bug or\n feature.\n\n3. Any significant changes should almost always be accompanied by tests. The project already has\n good test coverage, so look at some of the existing tests if you're unsure how to go about it.\n\n4. Do your best to have [well-formed commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for each change. This\n provides consistency throughout the project, and ensures that commit messages are able to be\n formatted properly by various git tools.\n\n5. Finally, push the commits to your fork and submit a [pull request](https://help.github.com/articles/creating-a-pull-request)."]]
