Developer Setup¶

Prerequisites¶

Tool	Version	Purpose
Go	1.25+	Build and test
git	Latest	Version control
Docker	Latest	Local MQ containers (integration tests)

No external build tools, task runners, or code generators are required. The Go toolchain provides everything needed.

Required repositories¶

mqrestadmin depends on two sibling repositories:

Repository	Purpose
mq-rest-admin-go	This project
standards-and-conventions	Canonical project standards (referenced by `AGENTS.md` and git hooks)
mq-rest-admin-dev-environment	Dockerized MQ test infrastructure (local and CI)

Recommended directory layout¶

Clone all three repositories as siblings:

~/dev/
├── mq-rest-admin-go/
├── standards-and-conventions/
└── mq-rest-admin-dev-environment/

cd ~/dev
git clone https://github.com/wphillipmoore/mq-rest-admin-go.git
git clone https://github.com/wphillipmoore/standards-and-conventions.git
git clone https://github.com/wphillipmoore/mq-rest-admin-dev-environment.git

Building¶

go build ./...          # Compile all packages
go vet ./...            # Run static analysis

There is no separate clean step -- Go caches builds automatically and invalidates when source files change.

Testing¶

go test ./...                          # Run all unit tests
go test -v ./...                       # Verbose output
go test -race ./...                    # Race detector enabled
go test -cover ./...                   # Show coverage summary
go test -coverprofile=coverage.out ./...  # Generate coverage profile
go tool cover -html=coverage.out       # View coverage in browser

Validation¶

Run all quality checks:

go build ./...          # Compile
go vet ./...            # Static analysis
go test -race ./...     # Tests with race detector

Git hooks¶

Enable repository git hooks before committing:

git config core.hooksPath scripts/git-hooks

The hooks enforce:

pre-commit: Branch naming conventions and protected branch rules
commit-msg: Conventional Commits format and co-author trailer validation

Documentation¶

Local setup¶

# Set up shared fragments symlink
scripts/dev/docs-setup.sh

# Install MkDocs
pip install mkdocs-material

# Build the documentation site
mkdocs build -f docs/site/mkdocs.yml

# Serve locally with live reload
mkdocs serve -f docs/site/mkdocs.yml