Contributing
April 12, 2019 ยท View on GitHub
Prerequisites
- Signed and verified CLA
- Golang 1.12.x
- (To run linter) https://github.com/golangci/golangci-lint in
$PATH
Common commands
Running the tests and coverage but no JUnit report
> go run mage.go -v test
Running the tests, coverage and JUnit report
> go run mage.go -v testWithReports
Running the linter
> go run mage.go -v lint
Workflows
Submitting an issue
-
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.
-
Open issue
-
Be as detailed as possible -
goversion, what did you do, what did you expect to happen, what actually happened.
Submitting a PR
- Find an existing issue to work on or follow
Submitting an issueto 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. - Branch out from latest
master. - Code, add, commit and push your changes in your branch.
- Make sure that tests and linter(s) pass locally for you.
- Submit a PR.
- Collaborate with the codeowners/reviewers to merge this in
master.
Releasing
Check out RELEASE_PROCESS