We'd love to accept your sample apps and patches! Before we can take them, we have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement (CLA).
- 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.
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
- Submit an issue describing your proposed change.
- The repo owner will respond to your issue promptly.
- If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
- Fork the repo, develop, and test your code changes.
- Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide] (https://googlecloudplatform.github.io/samples-style-guide/) for the recommended coding standards for this organization.
- Ensure that your code has an appropriate set of unit tests which all pass.
- Submit a pull request.
Sample apps should be in a top-level directory: /sample-app.
If the code has different instructions per platform, this should be explicitly noted in the README.
If the code is different per platform, a sub-directory should be used:
.
└── sample-app
├── managed
└── anthos
Samples that demonstrate integrations with Events for Cloud Run should be prefixed with events-: events-sample-app.
The testing directory contains resources for automated testing.
- If the sample is going to appear on cloud.google.com or be used by developers following instructions on cloud.google.com, it can be hosted in this repository.
- Tutorial instructions should not be included in the sample: the README should be used to point to separately published tutorials, and only contain instructions where a more official location is not available.
- If the sample highlights specific coding language practices in the context of Cloud Run, it should be hosted in a language-specific repository where the language practices can be properly reviewed, maintained, and subject to automated testing. This repository focuses on Dockerfiles, YAML, Shell scripts, and "architectural" solutions.
You may be asked to be the maintainer of a sample you contribute depending on it's intended use.