SUMMARY.md

Uber Go Style Guide

• Introduction
• Guidelines
  • Pointers to Interfaces
  • Verify Interface Compliance
  • Receivers and Interfaces
  • Zero-value Mutexes are Valid
  • Copy Slices and Maps at Boundaries
  • Defer to Clean Up
  • Channel Size is One or None
  • Start Enums at One
  • Use "time" to handle time
  • Errors
    • Error Types
    • Error Wrapping
    • Error Naming
    • Handle Errors Once
  • Handle Type Assertion Failures
  • Don't Panic
  • Use go.uber.org/atomic
  • Avoid Mutable Globals
  • Avoid Embedding Types in Public Structs
  • Avoid Using Built-In Names
  • Avoid init()
  • Exit in Main
    • Exit Once
  • Use field tags in marshaled structs
  • Don't fire-and-forget goroutines
    • Wait for goroutines to exit
    • No goroutines in init()
• Performance
  • Prefer strconv over fmt
  • Avoid repeated string-to-byte conversions
  • Prefer Specifying Container Capacity
• Style
  • Avoid overly long lines
  • Be Consistent
  • Group Similar Declarations
  • Import Group Ordering
  • Package Names
  • Function Names
  • Import Aliasing
  • Function Grouping and Ordering
  • Reduce Nesting
  • Unnecessary Else
  • Top-level Variable Declarations
  • Prefix Unexported Globals with _
  • Embedding in Structs
  • Local Variable Declarations
  • nil is a valid slice
  • Reduce Scope of Variables
  • Avoid Naked Parameters
  • Use Raw String Literals to Avoid Escaping
  • Initializing Structs
    • Use Field Names to Initialize Structs
    • Omit Zero Value Fields in Structs
    • Use var for Zero Value Structs
    • Initializing Struct References
  • Initializing Maps
  • Format Strings outside Printf
  • Naming Printf-style Functions
• Patterns
  • Test Tables
  • Functional Options
• Linting