|
| 1 | +Contributing |
| 2 | +============ |
| 3 | + |
| 4 | +1. **Please sign one of the contributor license agreements below.** |
| 5 | +1. Fork the repo, develop and test your code changes, add docs. |
| 6 | +1. Make sure that your commit messages clearly describe the changes. |
| 7 | +1. Send a pull request. |
| 8 | + |
| 9 | + |
| 10 | +Here are some guidelines for hacking on gcloud-java. |
| 11 | + |
| 12 | + |
| 13 | +Using maven for build/test |
| 14 | +-------------------------- |
| 15 | +After you cloned the repository use Maven for building and running the tests. |
| 16 | +Maven 3.0+ is required. |
| 17 | + |
| 18 | + |
| 19 | +Adding Features |
| 20 | +--------------- |
| 21 | +In order to add a feature to gcloud-java: |
| 22 | + |
| 23 | +The feature must be fully documented using Javadoc and examples should be provided. |
| 24 | +The feature must work fully on Java 7 and above. |
| 25 | +The feature must not add unnecessary dependencies (where "unnecessary" is of course subjective, |
| 26 | +but new dependencies should be discussed). |
| 27 | + |
| 28 | + |
| 29 | +Coding Style |
| 30 | +------------ |
| 31 | +Maintain the coding style in the project and in particular the modified files. |
| 32 | +Follow the Google Java [style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html). |
| 33 | + |
| 34 | + |
| 35 | +## Contributor License Agreements |
| 36 | + |
| 37 | +Before we can accept your pull requests you'll need to sign a Contributor |
| 38 | +License Agreement (CLA): |
| 39 | + |
| 40 | +- **If you are an individual writing original source code** and **you own the intellectual property**, |
| 41 | +then you'll need to sign an [individual CLA][indvcla]. |
| 42 | +- **If you work for a company that wants to allow you to contribute your work**, |
| 43 | +then you'll need to sign a [corporate CLA][corpcla]. |
| 44 | + |
| 45 | +You can sign these electronically (just scroll to the bottom). After that, |
| 46 | +we'll be able to accept your pull requests. |
| 47 | + |
| 48 | +[gcloudcli]: https://developers.google.com/cloud/sdk/gcloud/ |
| 49 | +[indvcla]: https://developers.google.com/open-source/cla/individual |
| 50 | +[corpcla]: https://developers.google.com/open-source/cla/corporate |
0 commit comments