Skip to content

Commit

Permalink
adding contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
aozarov committed Jan 20, 2015
1 parent 01e0ff7 commit 33acc84
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 1 deletion.
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Contributing
============

1. **Please sign one of the contributor license agreements below.**
1. Fork the repo, develop and test your code changes, add docs.
1. Make sure that your commit messages clearly describe the changes.
1. Send a pull request.


Here are some guidelines for hacking on gcloud-java.


Using maven for build/test
--------------------------
After you cloned the repository use Maven for building and running the tests.
Maven 3.0+ is required.


Adding Features
---------------
In order to add a feature to gcloud-java:

The feature must be fully documented using Javadoc and examples should be provided.
The feature must work fully on Java 7 and above.
The feature must not add unnecessary dependencies (where "unnecessary" is of course subjective,
but new dependencies should be discussed).


Coding Style
------------
Maintain the coding style in the project and in particular the modified files.
Follow the Google Java [style](http://google-styleguide.googlecode.com/svn/trunk/javaguide.html).


## Contributor License Agreements

Before we can accept your pull requests you'll need to sign a Contributor
License Agreement (CLA):

- **If you are an individual writing original source code** and **you own the intellectual property**,
then you'll need to sign an [individual CLA][indvcla].
- **If you work for a company that wants to allow you to contribute your work**,
then you'll need to sign a [corporate CLA][corpcla].

You can sign these electronically (just scroll to the bottom). After that,
we'll be able to accept your pull requests.

[gcloudcli]: https://developers.google.com/cloud/sdk/gcloud/
[indvcla]: https://developers.google.com/open-source/cla/individual
[corpcla]: https://developers.google.com/open-source/cla/corporate
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Java idiomatic client for Google Cloud Platform services. Supported APIs include
> Note: This package is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
Documentation and examples are available [here](https://github.com/GoogleCloudePlatform/gcloud-java/gh-pages/docs).
Documentation and examples are available [here](https://github.com/GoogleCloudePlatform/gcloud-java/gh-pages/apidocs).

## Google Cloud Datastore

Expand Down

0 comments on commit 33acc84

Please sign in to comment.