Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

25 lines (13 loc) · 1.51 KB
Raw

Contributing to IBM Cloud CLI SDK

👍First of all, thanks for your time to contribute!🎉

The following is a set of guidelines for` contributing to IBM Cloud CLI SDK. If you have any suggestion or issue regarding IBM Cloud CLI, you can go to ibm-cloud-cli-releases and file issues there.

Contribute Code

Before You Submit PR

Code Style

We follow the offical CodeReviewComments. Make sure you run gofmt and go vet to fix any major changes.

Unit Test

Make sure you have good unit test. Run go test -cover $(go list ./...), and ensure coverage is above 80% for major packages (aka packages other than i18n, fakes, docs...).

Secret Detection

This project uses the IBM Detect Secrets Module. Install the module, by following these instructions. Once installed, enable the pre-commit secret detection hook by following these instructions to ensure no secrets are committed to this repo.

Commit Message

Good commit message will greatly help review. We recommend AngularJS spec of commit message. You can use commitzen to help you compose the commit.