Contributing Guidelines

May 13, 2021 · View on GitHub

We're glad you're thinking about contributing to spaGO! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking issues tagged as "good-first-issue" is a good start!

Branching

The preferred flow is to fork the project, create branches in your fork, and submit PRs from your forked branch.

Requirements

API Development

Setup

Set the desired environment variable, for example:

export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOROOT:$GOPATH:$GOBIN

Install the following tools like this, if you haven't already.

brew install protobuf
go get -u google.golang.org/protobuf/proto
go get -u google.golang.org/protobuf/protoc-gen-go
go get -u google.golang.org/grpc

go install \
    google.golang.org/protobuf/cmd/protoc-gen-go \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc

Generate API source

After changing the gRPC protobuf specification, run go generate ./... from the top-level folder.