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.
Development guide¶
This document contains technical information to contribute to this repository.
Website¶
This repository includes scripts and configuration to build a website using Material for MkDocs:
config/mkdocs: MkDocs configuration filesscripts/run-mkdocssh: script to build the website.github/workflows/documentation.yaml: GitHub Actions workflow that builds the website, and pushes a commit with changes on the current branch.
Build the website¶
To build the website, run the following command from the root of the repository:
Preview the website¶
To preview the website, run the following command from the root of the repository: