Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

40 lines (35 loc) · 1.87 KB
Raw

Contribution Guidelines

Please read this guide if you plan to contribute to the Compage. We welcome any kind of contribution. No matter if you are an experienced programmer or just starting, we are looking forward to your contribution.

Reporting Issues

If you find a bug while working with the Compage, please open an issue on GitHub and let us know what went wrong. We will try to fix it as quickly as we can.

Feature Requests

You are more than welcome to open issues in this project to suggest new features.

Contributing Code

This project is written in Golang

To contribute code.

  1. Ensure you are running golang version 1.11.4 or greater for go module support
  2. Set the following environment variables: 
    GO111MODULE=on
GOFLAGS=-mod=vendor
  3. Fork the project.
  4. Clone the project: git clone https://github.com/[YOUR_USERNAME]/compage && cd compage
  5. kindly refer compage.md file to know the structure of the project.
  6. Commit changes (Please refer the commit message conventions)
  7. Push commits.
  8. Open pull request.

Regenerate the gRPC code from .proto files

  • Install below packages to regenerate the gRPC code. 
    go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
  • Update below statement in ~/.zshrc or ~/.bashrc depending on the shell you are using. 
    export PATH="$PATH:$(go env GOPATH)/bin"
  • Download buf binary from this link—https://github.com/bufbuild/buf/releases and fire the command from root directory of compage. 
    buf generate