Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.12 KB
Raw

Contributing

Prerequisites

Common commands

Running the tests

> go test ./...

Running the tests and coverage

> go test ./... -cover

Running the linter

> golangci-lint run

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.