tangoenskai / uber-go-style-guide-kr

Uber's Go Style Guide Official Translation in Korean. Linked to the uber-go/guide as a part of contributions

Summary

Engineering Manager at THECOO, Inc., crafting awesome artist-fan community platform.

Previously

• Solutions Engineer at CircleCI, one of the best CI/CD companies.
• Senior Software Engineer (Backend, Microservices) at Mercari, Inc., the first unicorn in Japan.

CV

• CV
• LinkedIn

Technologies & Tools

• Go, gRPC/Protobuf, Microservices
• Google Cloud Platform (Computer Engine, Kubernetes Engine, Spanner, Cloud SQL, Stackdriver, Logging, Dataflow, etc.)
• Terraform
• CircleCI, Spinnaker
• Datadog, Sentry, NewRelic, Pagerduty, Blameless
• Git, Github, Slack

uber-go-style-guide-kr's Issues

Update Korean translation

To people who want to contribute

We encourage you to create a PR proactively to support this.
Otherwise, I am going to finish:

• updating the contents up-to-date
• improve Korean translation

What

• update the Korean translation with the
  • recent update: 2020/06/10
  • 2020/04/19
  • 2022/03/30
  • 2022/10/18
• all new updates that have not been updated yet in Korean

Why

• the main recent update: 2020/06/10 has been merged into master
• current translation is not aligned with the latest doc

TODO

update these topics:

• Introduction: #13
• Guidelines: WIP by @TangoEnSkai
• Pointers to Interfaces: #14
• Verify Interface Compliance: #15
• Receivers and Interfaces: #16
• Zero-value Mutexes are Valid #17
• Copy Slices and Maps at Boundaries #18
• Defer to Clean Up #19
• Channel Size is One or None #20 WIP by @TangoEnSkai
• Start Enums at One
• Use "time" to handle time
• Error Types
• Error Wrapping
• 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
• Performance
• Prefer strconv over fmt
• Avoid string-to-byte conversion
• Prefer Specifying Container Capacity
• Specifying Map Capacity Hints
• Specifying Slice Capacity
• Style
• 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