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

Latest commit

 

History

History
56 lines (46 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

56 lines (46 loc) · 2.51 KB

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).

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. Sign a Contributor License Agreement, if you have not yet done so (see details above).
  2. Create your change to the repo in question.
    • Fork the desired repo, develop and test your code changes.
    • Ensure that your code is clear and comprehensible.
    • Ensure that your code has an appropriate set of unit tests which all pass.
  3. Submit a pull request.
  4. The repo owner will review your request. If it is approved, the change will be merged. If it needs additional work, the repo owner will respond with useful comments.

Contributing a New Sample App

  1. Sign a Contributor License Agreement, if you have not yet done so (see details above).

  2. Create your own repo for your app following this naming convention:

    • mirror-{app-name}-{language or platform}
    • apps: quickstart, photohunt-server, photohunt-client
    • example: mirror-quickstart-android
    • For multi-language apps, concatenate the primary languages like this: mirror-photohunt-server-java-python.
  3. Create your sample app in this repo.

    • Be sure to clone the README.md, CONTRIBUTING.md and LICENSE files from the googlesamples repo.
    • Ensure that your code is clear and comprehensible.
    • Ensure that your code has an appropriate set of unit tests which all pass.
    • Instructional value is the top priority when evaluating new app proposals for this collection of repos.
  4. Submit a request to fork your repo in googlesamples organization.

  5. The repo owner will review your request. If it is approved, the sample will be merged. If it needs additional work, the repo owner will respond with useful comments.