Code-Memo

Idiomatic Go

Formatting and naming

• Run gofmt / goimports on save.
• MixedCaps for exported names; short names in tight scopes (i, r, b), longer names for globals and function parameters.
• Getters are not named GetX; use X() for field x when appropriate (see standard library).

Errors

• Return error from fallible functions; wrap with fmt.Errorf("context: %w", err).
• Compare sentinel errors with errors.Is; extract types with errors.As.

Interfaces

• Define small interfaces where they are used, not where types are implemented.
• Accept interfaces, return structs (common advice for APIs you own).

Zero values

Design structs so the zero value is usable or obviously invalid — reduces constructor boilerplate when safe.

Line of sight

Handle errors in the happy path down the left margin; reduce deep nesting with early returns.

if err != nil {
	return err
}
// happy path continues

Avoid unnecessary abstraction

A plain for loop is often clearer than a generic chain. Prefer standard library patterns over frameworks for small services.

Documentation

Document exported symbols; start comments with the name (// User represents ...). Run go doc locally.

Concurrency

Do not hide goroutine lifetimes; tie long work to context.Context.

Testing

Table-driven tests, subtests with t.Run, examples that run as tests when they contain // Output:.