diff --git a/docs/gitbook/dev/dev-guide.md b/docs/gitbook/dev/dev-guide.md index 43a004f7..9e6e557b 100644 --- a/docs/gitbook/dev/dev-guide.md +++ b/docs/gitbook/dev/dev-guide.md @@ -58,18 +58,22 @@ Download Go modules: go mod download ``` -Build Flagger container image: +Build Flagger binary and container image: ```bash make build ``` -Run unit tests: +Build load tester binary and container image: ```bash -make test +make loadtester-build ``` +### Code changes + +Before submitting a PR, make sure your changes are covered by unit tests. + If you made changes to `go.mod` run: ```bash @@ -79,7 +83,19 @@ go mod tidy If you made changes to `pkg/apis` regenerate Kubernetes client sets with: ```bash -./hack/update-codegen.sh +make codegen +``` + +Run code formatters: + +```bash +make fmt +``` + +Run unit tests: + +```bash +make test ``` ### Manual testing