Skip to content

Latest commit

 

History

History
81 lines (56 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

81 lines (56 loc) · 2.43 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

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.

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.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Required Tools

Working with the project sources requires the following tools:

  1. git
  2. bzr
  3. go (version 1.11.4 and up)
  4. make
  5. docker

Repository Setup

Fork the repo, checkout the upstream repo to your GOPATH by:

$ GO111MODULE="" go get -d github.com/census-instrumentation/opencensus-service

Add your fork as an origin:

$ cd $(go env GOPATH)/src/github.com/census-instrumentation/opencensus-service
$ git remote add fork [email protected]:YOUR_GITHUB_USERNAME/opencensus-service.git

Run tests, fmt and lint:

$ make install-tools # Only first time.
$ make

Note: the default build target requires tools that are installed at $(go env GOPATH)/bin, ensure that $(go env GOPATH)/bin is included in your PATH.

Creating a PR

Checkout a new branch, make modifications, build locally, and push the branch to your fork to open a new PR:

$ git checkout -b feature
# edit
$ make
$ git commit
$ git push fork feature

General Notes

This project uses Go 1.11.4 and Travis for CI.

Travis CI uses the Makefile with the default target, it is recommended to run it before submitting your PR. It runs gofmt -s (simplify) and golint.

The dependencies are managed with go mod if you work with the sources under your $GOPATH you need to set the environment variable GO111MODULE=on.