Go Development

Go Development Guide

Production-ready patterns extracted from real projects.

Table of Contents

• Core Principle: LESS CODE = FEWER BUGS
• Architecture Decisions
• Linter Enforcement
• Enforced Project Structure
• References
  • Core Patterns
  • HTTP Layer
  • Production Patterns
  • Best Practices
• Examples
• Templates
• Commands
• Dependencies
• Version

Core Principle: LESS CODE = FEWER BUGS

This applies to ALL code — not just project scaffolding.

What this means:

• ❌ Don't write error types that won't be used

• ❌ Don't create custom error type for every error case

• ❌ Don't add methods "for completeness"

• ❌ Don't create helper functions that have one caller

• ❌ Don't add validation for impossible scenarios

• ❌ Don't implement interfaces "just in case"

• ❌ Don't add logging/metrics that nobody reads

• ❌ Don't create common, helpers, utils, shared, misc packages

• ✅ Write only what the feature requires

• ✅ Use few sentinel categories (ErrNotFound, ErrConflict) + wrap with context

• ✅ Typed errors only when caller needs to extract data (RetryAfter, Field)

• ✅ Add code when there's actual need

• ✅ Delete unused code immediately

• ✅ Prefer inline code over tiny functions

• ✅ Trust the type system, don't over-validate

• ✅ Name packages by what they provide, not what's in them

• ✅ Keep helper functions close to usage (unexported)

• ✅ If truly shared, create small purpose-named packages (internal/optional/)

• ❌ Don't modify .golangci.yml — linting config is protected

Examples:

Architecture Decisions

Linter Enforcement

All rules are enforced via golangci-lint (revive rules) in .golangci.yml:

Required Validation

After generating/modifying Go code:

golangci-lint run ./...

Do not modify .golangci.yml — linting config is protected by golangci-guard hook.

Enforced Project Structure

The skill MUST enforce this structure for all Go projects:

project/
├── cmd/
│   └── app/
│       └── main.go           # Entry point only
├── internal/
│   ├── config/
│   │   └── config.go         # Config with envPrefix
│   ├── errs/
│   │   └── errors.go         # Sentinel errors + helpers
│   ├── optional/
│   │   └── optional.go       # Pointer conversion helpers
│   ├── models/
│   │   └── {entity}.go       # Domain models + mappers
│   ├── services/
│   │   ├── registry.go       # Service registry
│   │   └── {entity}.go       # Business logic
│   ├── storage/
│   │   ├── storage.go        # Storage interface
│   │   ├── {entity}.go       # Repository impl
│   │   ├── main_test.go      # TestMain with testcontainers
│   │   └── testmigration/    # Test data fixtures (SQL)
│   │       ├── 100001_users.up.sql
│   │       └── 100001_users.down.sql
│   └── http/
│       └── v1/
│           ├── router.go     # Router + path constants
│           ├── {entity}_handler.go
│           ├── dto.go        # Request/Response types
│           └── json.go       # encode/decode
├── pkg/
│   ├── logger/
│   └── postgres/
├── migrations/
├── go.mod
├── .env.example
├── Makefile
├── Dockerfile
└── docker-compose.yml

Structure Rules

References

Core Patterns

HTTP Layer

Production Patterns

Best Practices

Examples

Core

HTTP Layer

Production

Templates

Dependencies

ALWAYS use @latest when adding new dependencies.

Recommended libraries:

# Core
go get golang.org/x/sync/errgroup@latest
go get github.com/caarlos0/env/v10@latest
go get github.com/jackc/pgx/v5@latest
go get github.com/Masterminds/squirrel@latest
go get github.com/pressly/goose/v3@latest
go get github.com/avast/retry-go@latest
go get github.com/google/uuid@latest
go get github.com/shopspring/decimal@latest

# HTTP Layer
go get github.com/go-chi/chi/v5@latest
go get github.com/go-playground/validator/v10@latest
go get gopkg.in/go-jose/go-jose.v2@latest

# Testing
go get github.com/stretchr/testify@latest
go get github.com/testcontainers/testcontainers-go@latest

# Tracing (OpenTelemetry)
go get go.opentelemetry.io/otel@latest
go get go.opentelemetry.io/otel/sdk@latest
go get go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc@latest
go get go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp@latest
go get github.com/exaring/otelpgx@latest

Version

• 1.20.0 — Advisory lock pattern for serializable transactions: Serialize() method, enforcement hook, /go-add-repository includes Serialize() by default
• 1.19.0 — Filter pattern for database queries: XxxFilter, getXxxCondition(), /go-add-repository generates filter scaffold
• 1.18.0 — Dependency version enforcement: PreToolUse hook for go get @latest
• 1.17.0 — Testcontainers integration: typed closer, testmigration/ fixtures, goose with sql.Open
• 1.16.1 — Fix golangci-lint v2 schema: imports-blocklist, remove deprecated options
• 1.16.0 — Protected .golangci.yml (hook + documentation)
• 1.15.0 — Package naming: no common/helpers/utils, purpose-named packages (optional/, json.go)
• 1.14.0 — Error handling: sentinel categories + wrap (internal/errs), helpers, no re-wrap
• 1.13.1 — golangci-lint v2 fix: typecheck is built-in, wsl (not wsl_v5), troubleshooting
• 1.13.0 — golangci-lint v2 migration (formatters, nolintlint anti-cheat, err113)
• 1.12.0 — Comprehensive linting configuration (revive, depguard, exclusion patterns)
• 1.11.1 — Channel axioms (nil/closed behavior, WaitMany, broadcast signaling)
• 1.11.0 — Effective Go patterns (control structures, interfaces, allocation, defer, embedding, blank identifier)
• 1.10.3 — Package structure decision guide (pkg/ vs internal/)
• 1.10.2 — Config: embedded structs only (no named fields in main Config)
• 1.10.1 — Fix: UserColumns() in models package only (not repository)
• 1.10.0 — Repository pattern: Save as upsert, UserColumns() function, Values() method
• 1.9.0 — Authentication patterns (gateway-based, full JWT validation)
• 1.8.0 — Code quality tools (deadcode analysis, make deadcode target)
• 1.7.1 — Comment conventions (stdlib-style doc comments, no decorative separators)
• 1.7.0 — Handler-per-entity, Optional[T], JSONB types, Mapper pattern, Config envPrefix, IDs as string
• 1.6.1 — Money pattern: NUMERIC database storage (was TEXT)
• 1.6.0 — Money pattern (decimal precision, currency conversion, exchange rates)
• 1.5.0 — Enhanced testing (testcontainers, testify mock, CI/Local detection)
• 1.4.0 — Entry point pattern (backend, errgroup, graceful shutdown)
• 1.3.0 — Best practices (naming, concurrency, pitfalls, performance)
• 1.2.0 — Simple errors, OpenTelemetry tracing
• 1.1.0 — HTTP Layer, Enhanced Errors, Production Patterns (pagination, health, workers)
• 1.0.0 — Initial release

Converted and distributed by TomeVault — claim your Tome and manage your conversions.