mcpField
G
go-best-practices

go-best-practices

github.com/potetoDevelopment571214 installsUpdated 32w ago
Repository

About go-best-practices

A Go development skill that collects practices for application structure, concurrency, configuration, testing, logging, and linting. It is for developers building Go binaries and long-running services, with concise rules and a linked pattern reference for code examples.

Key features

  1. 01Minimal main and shared bootstrap
  2. 02Ordered shutdown and non-blocking fanout
  3. 03Deterministic concurrency and leak tests
  4. 04Layered config and platform paths
  5. 05Secret-redacting debug logs
  6. 06Golden tests and focused linters

Use cases

  1. 01Structuring a new Go binary
  2. 02Managing shutdown in a long-running service
  3. 03Testing goroutines and channel behavior
  4. 04Setting config precedence across sources

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/poteto/noodle --skill go-best-practices

After installing, type/go-best-practicesin Claude Code to confirm it loaded.

Bundled filesreferences/patterns.md

Details

From the project README

Go Best Practices

PatternWhen to apply
Minimal mainNew binaries
Single bootstrapApp wiring across modes
Ordered shutdownLong-running processes
Non-blocking fanoutChannel-based event systems
Concurrency testingAny goroutine code
Layered configMulti-source configuration
Cross-platform pathsFile/config path resolution
Secure debug loggingHTTP client instrumentation
Golden test matricesRendering / output components
Focused lintersCI pipeline setup

Read references/patterns.md for code examples.

Rules

  1. main.go is a stub. Call cmd.Execute() and nothing else. Gate diagnostics (pprof) behind env vars.

  2. One bootstrap path. All modes (interactive, headless, test) share the same initialization function. Two paths will drift.

  3. Ordered shutdown. Cancel dependents before their dependencies, then run independent cleanup in parallel under a timeout context. WaitGroup the parallel phase.

  4. Never block the sender. Non-blocking channel sends with an explicit drop policy. Log drops at debug level. Document the policy.

  5. Test concurrency mechanically. testing/synctest for deterministic timing, goleak.VerifyNone for leak detection, dedicated regression tests for timer/channel deadlocks.

  6. Explicit config precedence. Global → project → flags. Walk up from CWD to discover project configs, reverse so closest wins, deep-merge.

  7. Centralize platform paths. One function per concern. Resolution order: env override → XDG → platform default → fallback.

  8. Redact secrets in debug logs. Wrap http.RoundTripper. Filter headers matching authorization, api-key, token, secret. Gate on debug level to skip allocation in prod.

  9. Golden tests over matrices. Cross dimensions (layout × theme × size) as parallel subtests. Sweep continuous ranges to catch off-by-one bugs.

  10. Focused linters, not all linters. Enable what catches real bugs (bodyclose, noctx, tparallel). Disable noisy defaults. Add project-specific checks as scripts. Always -race in tests.

Comments

Markdown supported