diff --git a/docs/development.md b/docs/development.md index ed88689..93e2460 100644 --- a/docs/development.md +++ b/docs/development.md @@ -73,6 +73,15 @@ go test -run TestName -v ./pkg/server/... # Run a single test `TestFooNilResponse` methods. - Use `golang/mock` for mocking interfaces. +## Before committing + +Run `just ready` before committing to ensure generated code, package docs, +formatting, and lint are all up to date: + +```bash +just ready # go::generate, go::docs, go::fmt, go::vet +``` + ## Branching All changes should be developed on feature branches. Create a branch from diff --git a/justfile b/justfile index a60578d..20ff2be 100644 --- a/justfile +++ b/justfile @@ -28,5 +28,7 @@ test: # Format and lint before committing ready: + just go::generate + just go::docs just go::fmt just go::vet