From bdbe1a94167d5a57fb37e985f5313c26d9aff95d Mon Sep 17 00:00:00 2001 From: Justin Harms Date: Mon, 1 Jun 2026 05:58:22 -0500 Subject: [PATCH] Update AGENTS.md and Makefile for improved build and test instructions - Revised the build and test instructions in `AGENTS.md` to emphasize the importance of formatting, testing, and building before finalizing code changes. - Enhanced comments in the `Makefile` to clarify the purpose of each target, including `run`, `dev`, `build`, `docker`, `test`, `test-race`, and `fmt`. --- AGENTS.md | 5 +---- Makefile | 14 +++++++------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 06cc58c..50156fc 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,10 +29,7 @@ Key product constraints: ## Build and test Use `make help` as the source of truth for available build/test targets and descriptions. -Always build and test via make unless it doesn't include targets for that. -Also in the event there is a test without race checking and one with do both. -Otherwise just whats available. -To verify your changes you must run tests and do a build. +Format, Test, Build are the required steps before being done with any coding if there are more then one target for any of these then run them all before considering that step complete. ## Coding conventions diff --git a/Makefile b/Makefile index 052e859..eb3460c 100644 --- a/Makefile +++ b/Makefile @@ -18,26 +18,26 @@ help: @echo " make fmt - Format Go code" @echo " make clean - Remove built artifacts" -run: dev +run: dev # Run the application alias for dev. -dev: build +dev: build # Run the application. $(BIN) server --config $(CONFIG) -build: clean +build: clean # Build the application. npm --prefix ./web/ui run build mkdir -p $(BIN_DIR) CGO_ENABLED=0 go build -o $(BIN) $(CMD_DIR) -docker: +docker: # Build the Docker image. docker build -t $(DOCKER_IMAGE) . -test: +test: # Run the tests. go test -timeout 30s -shuffle=on ./... -test-race: +test-race: # Run the tests with the race detector. go test -race -timeout 30s -shuffle=on ./... -fmt: +fmt: # Format the code using gofmt. go fmt ./... clean: