Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.84 KB
Raw

Contributing

  1. Sign one of the contributor license agreements below.

  2. Install Go

  3. Get the package:

    go get -d github.com/GoogleCloudPlatform/golang-samples

  4. Change into the checked out source:

    cd $(go env GOPATH)/src/github.com/GoogleCloudPlatform/golang-samples

  5. Fork the repo.

  6. Set your fork as a remote:

    git remote add fork [email protected]:GITHUB_USERNAME/golang-samples.git

  7. Make changes, commit to your fork.

  8. Send a pull request with your changes.

Testing

Running system tests

  1. Set the GOLANG_SAMPLES_PROJECT_ID environment variable to a suitable test project.

  2. Ensure you are logged in using gcloud login or set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path of your credentials file. Tests are authenticated using Application Default Credentials.

  3. Install the test dependencies:

    go get -t -d github.com/GoogleCloudPlatform/golang-samples/...

  4. Run the tests:

    go test github.com/GoogleCloudPlatform/golang-samples/...

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.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

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