CONTRIBUTING.md

How to contribute

Thank you for your contribution to gRPC-Gateway. Here's the recommended process of contribution.

1. go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
2. cd $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway
3. hack, hack, hack...
4. Make sure that your change follows best practices in Go
   • Effective Go
   • Go Code Review Comments
5. Make sure that go test ./... passes.
6. Sign a Contributor License Agreement
7. Open a pull request in GitHub

When you work on a larger contribution, it is also recommended that you get in touch with us through the issue tracker.

Code reviews

All submissions, including submissions by project members, require review.

I want to regenerate the files after making changes

Using Docker

It should be as simple as this (run from the root of the repository):

docker run -v $(pwd):/src/grpc-gateway --rm docker.pkg.github.com/grpc-ecosystem/grpc-gateway/build-env:1.16 \
    /bin/bash -c 'cd /src/grpc-gateway && \
        make install && \
        make clean && \
        make generate'
docker run -itv $(pwd):/grpc-gateway -w /grpc-gateway --entrypoint /bin/bash --rm \
    l.gcr.io/google/bazel:3.5.0 -c '\
        bazel run :gazelle -- update-repos -from_file=go.mod -to_macro=repositories.bzl%go_repositories && \
        bazel run :gazelle && \
        bazel run :buildifier'

You may need to authenticate with GitHub to pull docker.pkg.github.com/grpc-ecosystem/grpc-gateway/build-env. You can do this by following the steps on the GitHub Package docs.

Using Visual Studio Code dev containers

This repo contains a devcontainer.json configuration that sets up the build environment in a container using VS Code dev containers. If you're using the dev container, you can run the commands directly in your terminal:

$ make install && make clean && make generate

$ bazel run :gazelle -- update-repos -from_file=go.mod -to_macro=repositories.bzl%go_repositories && \
    bazel run :gazelle && \
    bazel run :buildifier

Note that the above-listed docker commands will not work in the dev container, since volume mounts from nested docker container is not possible.

If this has resulted in some file changes in the repo, please ensure you check those in with your merge request.

Making a release

To make a release, follow these steps:

1. Decide on a release version. The gorelease job can recommend whether the new release should be a patch or minor release. See CircleCI for an example.
2. Tag the release on master.
   1. The release can be created using the command line, or also through GitHub's releases UI.
   2. If you create a release using the web UI you can publish it as a draft and have it reviewed by another maintainer.
   3. Update the release description. Try to include some of the highlights of this release, ideally with links to the PRs and crediting the contributors.
3. Sit back and pat yourself on the back for a job well done 👏.