CONTRIBUTING.md

Contributing

Prerequisites

• Signed and verified CLA.
• Golang 1.15.x or use https://github.com/syndbg/goenv to use correct go version.
• (To run linter) https://github.com/golangci/golangci-lint in $PATH.
• (To run integration tests) Docker 17/18.x.x installed and docker in $PATH.

Common commands

Running only unit tests with coverage

> go run mage.go -v unitTests

Running tests (incl. integration tests) with coverage

> go run mage.go -v test

Running the linter

> go run mage.go -v lint

Workflows

Submitting an issue

1. Check existing issues and verify that your issue is not already submitted. If it is, it's highly recommended to add to that issue with your reports.
2. Open issue
3. Be as detailed as possible - go version, what did you do, what did you expect to happen, what actually happened.

Submitting a PR

1. Find an existing issue to work on or follow Submitting an issue to create one that you're also going to fix. Make sure to notify that you're working on a fix for the issue you picked.
2. Branch out from latest master.
3. Code, add, commit and push your changes in your branch.
4. Make sure that tests and linter(s) pass locally for you.
5. Submit a PR.
6. Collaborate with the codeowners/reviewers to merge this in master.

Releasing

Check out RELEASE_PROCESS