How to contribute

We definitely welcome patches and contribution to grpc! Here are some guidelines and information about how to do so.

Sending patches

Getting started

  1. Check out the code:

     $ go get
     $ cd $GOPATH/src/
  2. Create a fork of the grpc-go repository.

  3. Add your fork as a remote:

     $ git remote add fork$YOURGITHUBUSERNAME/grpc-go.git
  4. Make changes, commit them.

  5. Run the test suite:

     $ make test
  6. Push your changes to your fork:

     $ git push fork ...
  7. Open a pull request.

Legal requirements

In order to protect both you and ourselves, you will need to sign the Contributor License Agreement.

Filing Issues

When filing an issue, make sure to answer these five questions:

  1. What version of Go are you using (go version)?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

Contributing code

Unless otherwise noted, the Go source files are distributed under the BSD-style license found in the LICENSE file.