CONTRIBUTING.md

Contributing guide

Hi! We're really excited that you're interested in contributing! Before submitting your contribution, please read through the following guide.

General guidelines

• Bug fixes and changes discussed in the existing issues are always welcome.
• For new ideas, please open an issue to discuss them before sending a PR.
• Make sure your PR passes go test ./... and has appropriate commit messages.

Project setup

Install golangci-lint:

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b bin v1.52.2

Install mockgen:

GOBIN=$(pwd)/bin go install go.uber.org/mock/mockgen@latest

Run golangci-lint:

bin/golangci-lint run

Testing

Run tests:

go test ./...

To regenerate the mocks;

mocks/gen_mocks.sh