You want to contribute to AI Platform samples? That's awesome! Please refer to the short guide below.
| Criteria | Samples |
|---|---|
| Introduction | Yes |
| Prerequisites | Yes |
| Setup | Yes |
| Steps for completion with code and instructions | Yes |
| Next Steps | Optional |
We are happy to see your enthusiasm. This table lists the criteria and how important is it to follow when you make your contributions.
| Criteria | Core Samples | Contrib Samples |
|---|---|---|
| Include requirements.txt for dependencies | Yes | Yes |
| Include unit tests | Yes | Optional |
| Include integration tests | Yes | Optional |
| Include core TF API aka no contrib | Yes | Optional |
| Include README | Yes | Yes |
| Maintain version dependency updates | Yes | Optional |
We'd love to accept your AI Platform samples 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 to the repo in question.
- 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 desired 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 for the recommended coding standards for this organization.
- Ensure that your code is tested succesfully.
- Submit a pull request.