aboutsummaryrefslogtreecommitdiff
path: root/CONTRIB.md
diff options
context:
space:
mode:
authorLorenzo Castelli <lcastelli@google.com>2018-10-23 14:26:17 -0700
committerLorenzo Castelli <lcastelli@google.com>2018-10-24 11:12:35 -0700
commit3e72d05138bfed064b4100c0186c635eddddb577 (patch)
tree7bc525311a3ede73de89a4a64bfe4b67ec351c13 /CONTRIB.md
parent419bf9d7c345a2478c78a1f1b664da3fb693fb0d (diff)
downloadcompute-archlinux-image-builder-3e72d05138bfed064b4100c0186c635eddddb577.tar.xz
Brings the project up to date with a new bash implementation.
See the updated README for more information about images generated by the new script.
Diffstat (limited to 'CONTRIB.md')
-rw-r--r--CONTRIB.md76
1 files changed, 20 insertions, 56 deletions
diff --git a/CONTRIB.md b/CONTRIB.md
index b368291..939e534 100644
--- a/CONTRIB.md
+++ b/CONTRIB.md
@@ -1,64 +1,28 @@
-# How to become a contributor and submit your own code
+# How to Contribute
-## Contributor License Agreements
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
-We'd love to accept your sample apps and patches! Before we can take them, we
-have to jump a couple of legal hurdles.
+## Contributor License Agreement
-Please fill out either the individual or corporate Contributor License Agreement
-(CLA).
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution;
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
- * 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).
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
-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.
+## Code reviews
-## Contributing A Patch
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
-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.
+## Community Guidelines
-## 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. \ No newline at end of file
+This project follows [Google's Open Source Community
+Guidelines](https://opensource.google.com/conduct/).