From 4b2a0dce582d83491f0a222d3083289026b79be4 Mon Sep 17 00:00:00 2001 From: Jeremy Edwards Date: Mon, 9 Dec 2013 11:59:43 -0800 Subject: Add instructions on how to contribute to the project. --- CONTRIB.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 67 insertions(+) create mode 100644 CONTRIB.md diff --git a/CONTRIB.md b/CONTRIB.md new file mode 100644 index 0000000..caeda73 --- /dev/null +++ b/CONTRIB.md @@ -0,0 +1,64 @@ +# 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] + (https://developers.google.com/open-source/cla/individual). + * If you work for a company that wants to allow you to contribute your work, + then you'll need to sign a [corporate CLA] + (https://developers.google.com/open-source/cla/corporate). + +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. +1. The repo owner will respond to your issue promptly. +1. If your proposed change is accepted, and you haven't already done so, sign a + Contributor License Agreement (see details above). +1. Fork the desired repo, develop and test your code changes. +1. 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://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the + recommended coding standards for this organization. +1. Ensure that your code has an appropriate set of unit tests which all pass. +1. Submit a pull request. + +## Contributing A New Sample App + +1. Submit an issue to the GoogleCloudPlatform/Template repo describing your + proposed sample app. +1. 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. +1. If your proposal is accepted, and you haven't already done so, sign a + Contributor License Agreement (see details above). +1. 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. + +1. Clone the README.md, CONTRIB.md and LICENSE files from the + GoogleCloudPlatform/Template repo. +1. 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://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the + recommended coding standards for this organization. +1. Ensure that your code has an appropriate set of unit tests which all pass. +1. Submit a request to fork your repo in GoogleCloudPlatform organizationt via + your proposal issue. diff --git a/README.md b/README.md index e937bdc..3ee2747 100644 --- a/README.md +++ b/README.md @@ -13,5 +13,8 @@ Refer to [Building a Google Compute Engine Image](https://developers.google.com/ ## Source Code This repository is structured so that each package is located in its own top-level directory. [`google-startup-scripts`](google-startup-scripts/) and [`google-daemon`](google-daemon/) are stored as the directory structure of where the files would be from root. [`image-bundle`](image-bundle/) has no directory structure. +## Contributing +We welcome bug fixes and enhancements. Before you can submit patches please sign our Contributor License Agreement. See CONTRIB.md for more information. + ## License All files in this repository are under the [Apache License, Version 2.0](LICENSE) unless noted otherwise. -- cgit v1.2.1