Skip to content
This repository has been archived by the owner on Sep 7, 2018. It is now read-only.

Latest commit

 

History

History
38 lines (29 loc) · 2.97 KB

CONTRIB.md

File metadata and controls

38 lines (29 loc) · 2.97 KB
Raw

How to become a contributor and submit your own code

Contributor License Agreements

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.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop and test your code changes.
  5. 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.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request.

Contributing A New Sample App

  1. Submit an issue to the GoogleCloudPlatform/Template repo describing your proposed sample app.
  2. The Template repo owner will respond to your enhancement issue promptly. Instructional value is the top priority when evaluating new app proposals for this collection of repos.
  3. If your proposal is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Create your own repo for your app following this naming convention:
    • {product}-{app-name}-{language}
    • products: appengine, compute, storage, bigquery, prediction, cloudsql
    • example: appengine-guestbook-python
    • For multi-product apps, concatenate the primary products, like this: compute-appengine-demo-suite-python.
    • For multi-language apps, concatenate the primary languages like this: appengine-sockets-python-java-go.
  5. Clone the README.md, CONTRIB.md and LICENSE files from the GoogleCloudPlatform/Template repo.
  6. 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.
  7. Ensure that your code has an appropriate set of unit tests which all pass.
  8. Submit a request to fork your repo in GoogleCloudPlatform organizationt via your proposal issue.