Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (26 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 2.86 KB

How to Contribute

We'd love to accept your patches and contributions to this project! This guide will help you get started and understand our expectations for a great pull request.

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.

What makes a great pull request?

To ensure your contributions can be reviewed and merged efficiently, please focus on the following to help us merge your changes quickly:

  • Clarity: Describe the problem you are solving and the approach you took in the PR description.
  • Purpose: Ensure your PR has a clear, singular goal. If you are fixing multiple unrelated issues, please submit separate pull requests.
  • Testing: Whenever possible, include tests that cover your new code or reproduce the bug you are fixing.
  • History: Use separate commits, ordered logically, to make it easier for others to review your PR.
  • Documentation: If your change affects users or other developers, please update the relevant documentation as part of your PR.

For an example of exactly what we look for when contributing, please see this reference PR

Contribution process

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.

Once you submit your PR, a maintainer will review it. If it doesn't meet the guidelines, we may drop a standard reply asking you to update the PR. We will also add a tag to surface that the PR has been reviewed. If there is no response in 2 weeks, we will close the PR as stale with a note to file a new PR under the guidelines if you are still experiencing the issue.

Docsite-specific Notes

When contributing docs:

  1. Author in source docs under src/content/docs/docs/; do not edit generated src/content/docs/docs/{js,go,dart,python}/... pages directly.
  2. Use neutral internal docs links (/docs/<slug>/) in source docs. Language-specific paths are resolved during generation/runtime.
  3. Language-specific cross-link warnings during generation are non-blocking and indicate targets missing in a language.