Golang Code Style
Samuel BertheCommunityCreated by samberDistributed by Samuel Berthe
- Skill
- Guidelines
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a set of Go programming guidelines that emphasize readability and semantic clarity over rigid formatting. It covers best practices for variable declarations, control flow, function design, and code organization. The guidelines are intended to supplement automated linters by addressing human-judgment aspects of code style, such as reducing nesting, managing complex conditions, and determining when to use pointers versus value types.
What it does
- Provides rules for breaking long lines at semantic boundaries.
- Defines conventions for variable initialization and slice/map usage.
- Offers patterns for reducing nesting through early returns.
- Suggests strategies for simplifying complex conditional logic.
- Outlines best practices for function parameter design and organization.
- Advises on when to pass arguments by value versus by pointer.
When to use it
- When writing new Go code and seeking to follow community-aligned style patterns.
- During code reviews to identify areas for improved clarity and maintainability.
- When establishing coding standards for a new Go project.
- When refactoring complex functions to improve readability.
Advantages
- Promotes consistent and readable code across a team.
- Reduces cognitive load by enforcing simple, focused function design.
- Helps prevent common Go pitfalls like nil map panics.
- Provides clear guidance on performance-related decisions like memory allocation and pointer usage.
Usage examples
- “Review this function for Go style: does it follow the early return pattern?”
- The agent analyzes the function's control flow, identifies nested blocks, and suggests refactoring them into guard clauses to keep the happy path at minimal indentation.
- “How should I handle a function with six parameters in Go?”
- The agent advises grouping the parameters into an options struct to improve readability and maintainability, adhering to the guideline of keeping functions focused.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/samber/golang-code-style/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip golang-code-style.zip -d .agents/skills
Documentation by samber
Orchestration mode: Fan out the sub-agents described in the "Parallelizing Code Style Reviews" section, each covering an independent style concern, when reviewing code style across a large codebase, and merge their findings. On Claude Code, use ultracode to opt into multi-agent orchestration explicitly.
Community default. A company skill that explicitly supersedes
samber/cc-skills-golang@golang-code-styleskill takes precedence.
Go Code Style
Style rules that require human judgment — linters handle formatting, this skill handles clarity. For naming see samber/cc-skills-golang@golang-naming skill; for design patterns see samber/cc-skills-golang@golang-design-patterns skill; for struct/interface design see samber/cc-skills-golang@golang-structs-interfaces skill.
"Clear is better than clever." — Go Proverbs
When ignoring a rule, add a comment to the code.
Line Length & Breaking
No rigid line limit, but lines beyond ~120 characters MUST be broken. Break at semantic boundaries, not arbitrary column counts. Function calls with 4+ arguments MUST use one argument per line — even when the prompt asks for single-line code:
// Good — each argument on its own line, closing paren separate
mux.HandleFunc("/api/users", func(w http.ResponseWriter, r *http.Request) {
handleUsers(
w,
r,
serviceName,
cfg,
logger,
authMiddleware,
)
})When a function signature is too long, the real fix is often fewer parameters (use an options struct) rather than better line wrapping. For multi-line signatures, put each parameter on its own line.
Variable Declarations
SHOULD use := for non-zero values, var for zero-value initialization. The form signals intent: var means "this starts at zero."
var count int // zero value, set later
name := "default" // non-zero, := is appropriate
var buf bytes.Buffer // zero value is ready to useSlice & Map Initialization
Slices and maps MUST be initialized explicitly, never nil. Nil maps panic on write; nil slices serialize to null in JSON (vs [] for empty slices), surprising API consumers.
users := []User{} // always initialized
m := map[string]int{} // always initialized
users := make([]User, 0, len(ids)) // preallocate when capacity is known
m := make(map[string]int, len(items)) // preallocate when size is knownDo not preallocate speculatively — make([]T, 0, 1000) wastes memory when the common case is 10 items.
Composite Literals
Composite literals MUST use field names — positional fields break when the type adds or reorders fields:
srv := &http.Server{
Addr: ":8080",
ReadTimeout: 5 * time.Second,
WriteTimeout: 10 * time.Second,
}Control Flow
Reduce Nesting
Errors and edge cases MUST be handled first (early return). Keep the happy path at minimal indentation:
func process(data []byte) (*Result, error) {
if len(data) == 0 {
return nil, errors.New("empty data")
}
parsed, err := parse(data)
if err != nil {
return nil, fmt.Errorf("parsing: %w", err)
}
return transform(parsed), nil
}Eliminate Unnecessary else
When the if body ends with return/break/continue, the else MUST be dropped. Use default-then-override for simple assignments — assign a default, then override with independent conditions or a switch:
// Good — default-then-override with switch (cleanest for mutually exclusive overrides)
level := slog.LevelInfo
switch {
case debug:
level = slog.LevelDebug
case verbose:
level = slog.LevelWarn
}
// Bad — else-if chain hides that there's a default
if debug {
level = slog.LevelDebug
} else if verbose {
level = slog.LevelWarn
} else {
level = slog.LevelInfo
}Complex Conditions & Init Scope
When an if condition has 3+ operands, MUST extract into named booleans — a wall of || is unreadable and hides business logic. Keep expensive checks inline for short-circuit benefit. Details
// Good — named booleans make intent clear
isAdmin := user.Role == RoleAdmin
isOwner := resource.OwnerID == user.ID
isPublicVerified := resource.IsPublic && user.IsVerified
if isAdmin || isOwner || isPublicVerified || permissions.Contains(PermOverride) {
allow()
}Scope variables to if blocks when only needed for the check:
if err := validate(input); err != nil {
return err
}Switch Over If-Else Chains
When comparing the same variable multiple times, prefer switch:
switch status {
case StatusActive:
activate()
case StatusInactive:
deactivate()
default:
panic(fmt.Sprintf("unexpected status: %d", status))
}Function Design
Functions SHOULD be short and focused — one function, one job.
Functions SHOULD have ≤4 parameters. Beyond that, use an options struct (see
samber/cc-skills-golang@golang-design-patternsskill).Parameter order:
context.Contextfirst, then inputs, then output destinations.Naked returns help in very short functions (1-3 lines) where return values are obvious, but become confusing when readers must scroll to find what's returned — name returns explicitly in longer functions.
func FetchUser(ctx context.Context, id string) (*User, error)
func SendEmail(ctx context.Context, msg EmailMessage) error // grouped into structPrefer range for Iteration
SHOULD use range over index-based loops. Use range n (Go 1.22+) for simple counting.
for _, user := range users {
process(user)
}Value vs Pointer Arguments
Pass small types (string, int, bool, time.Time) by value. Use pointers when mutating, for large structs (~128+ bytes), or when nil is meaningful. Details
Code Organization Within Files
Group related declarations: type, constructor, methods together
Order: package doc, imports, constants, types, constructors, methods, helpers
One primary type per file when it has significant methods
Blank imports (
_ "pkg") register side effects (init functions). Restricting them tomainand test packages makes side effects visible at the application root, not hidden in library codeDot imports pollute the namespace and make it impossible to tell where a name comes from — never use in library code
Unexport aggressively — you can always export later; unexporting is a breaking change. → See
samber/cc-skills-golang@golang-goplsskill to unexport safely — its rename updates every call site atomically and refuses the change when lowercasing a method would break interface satisfaction, a breakage grep/sed silently ships.
String Handling
Use strconv for simple conversions (faster), fmt.Sprintf for complex formatting. Use %q in error messages to make string boundaries visible. Use strings.Builder for loops, + for simple concatenation.
Type Conversions
Prefer explicit, narrow conversions. Use generics over any when a concrete type will do:
func Contains[T comparable](slice []T, target T) bool // not []anyPhilosophy
"A little copying is better than a little dependency"
Use
slicesandmapsstandard packages; for filter/group-by/chunk, usegithub.com/samber/lo"Reflection is never clear" — avoid
reflectunless necessaryDon't abstract prematurely — extract when the pattern is stable
Minimize public surface — every exported name is a commitment
Parallelizing Code Style Reviews
When reviewing code style across a large codebase, use up to 5 parallel sub-agents, each targeting an independent style concern (e.g. control flow, function design, variable declarations, string handling, code organization).
Enforce with Linters
Many rules are enforced automatically: gofmt, gofumpt, goimports, gocritic, revive, wsl_v5. → See the samber/cc-skills-golang@golang-lint skill.
Cross-References
→ See the
samber/cc-skills-golang@golang-namingskill for identifier naming conventions→ See the
samber/cc-skills-golang@golang-structs-interfacesskill for pointer vs value receivers, interface design→ See the
samber/cc-skills-golang@golang-design-patternsskill for functional options, builders, constructors→ See the
samber/cc-skills-golang@golang-lintskill for automated formatting enforcement→ See
samber/cc-skills-golang@golang-continuous-integrationskill for automated AI-driven code review in CI using these guidelines→ See
samber/cc-skills-golang@golang-refactoringskill for mechanically applying guard-clause conversion, function extraction, and options-struct migration safely across many call sites once a review surfaces violations at scale
Files
- ATTRIBUTION.mdAdded by AutoGineer908 B
- LICENSELicence file added by AutoGineer1.0 KiB
- SKILL.md9.7 KiB
- evals/evals.json35.0 KiB
- references/details.md2.7 KiB
references/details.md
Code Style Details
Extract Complex Conditions
When if conditions span multiple operands, extract into named booleans:
// Good — self-documenting
isAdmin := user.Role == RoleAdmin
isOwner := resource.OwnerID == user.ID
hasOverride := permissions.Contains(PermOverride)
if isAdmin || isOwner || hasOverride {
allow()
}
// Bad — wall of logic
if user.Role == RoleAdmin || resource.OwnerID == user.ID || permissions.Contains(PermOverride) {
allow()
}Exception: When the last condition involves expensive processing, keep it inline to benefit from short-circuit evaluation:
// Good — avoid expensive operation when possible
if isAdmin || isOwner || expensivePermissionCheck(user, resource) {
allow()
}
// Wasteful — always runs expensive check
canOverride := expensivePermissionCheck(user, resource)
if isAdmin || isOwner || canOverride {
allow()
}Value vs Pointer Arguments
This covers function parameters, not method receivers (see samber/cc-skills-golang@golang-structs-interfaces skill for receiver rules).
Pass small, fixed-size types by value — strings are already a (pointer, length) pair internally:
// Good — value types by value
func FormatUser(name string, age int, createdAt time.Time) string
// Good — pointer for mutation
func PopulateDefaults(cfg *Config)
// Good — pointer when nil is meaningful (optional field update)
func UpdateUser(ctx context.Context, id string, name *string) error
// Bad — pointer for no reason
func Greet(name *string) stringWhen to use pointers:
The function mutates the value
The struct is large (~128+ bytes) — avoids copying overhead
Nil is meaningful (optional/nullable parameter)
When NOT to use pointers:
string,int,bool,float64,time.Time— pass by valueRead-only access to small structs — pass by value (better cache locality)
"Just to save memory" — value copy is negligible; stack allocation is fast
Memory access trade-offs when strong performance is required:
Values (no pointer): Stack allocation, excellent CPU cache locality for small types, zero indirection cost. Slower only when copying large structs.
Pointers: One extra dereference (negligible on modern CPUs), but risk cache misses if pointed-to data isn't in cache. Essential for large structs (>~128 bytes) where copy cost dominates.
Rule of thumb: For structs <~128 bytes with read-only access, values are typically faster due to cache locality. For mutation or large structs, pointers win. When in doubt, benchmark.
-> See the samber/cc-skills-golang@golang-structs-interfaces skill for pointer vs value receiver rules.
Requirements and compatibility
Written for: Claude Code, OpenAI Codex
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Declares allowed tools, Claude Code frontmatter
The author says: Designed for Claude Code, Codex or similar harness, and for projects using Golang.
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- samber
- Publisher
- Samuel Berthe (Community)
- Distributed by
- Samuel Berthe
- Source
- samber/cc-skills-golang · skills/golang-code-style · commit bb1d43d
- Licence
- MIT License (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by samber or Samuel Berthe.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download golang-code-style.zip