👍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.
This repository's default branch is master as that is from where we release. However, we develop in the dev branch. Make sure to create your feature branch from dev and also choose this as base for opening pull requests.
We follow the official CodeReviewComments. Make sure you run gofmt and go vet to fix any major changes.
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...).
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.
Good commit message will greatly help review. We recommend AngularJS spec of commit message. You can use commitzen to help you compose the commit.