https://github.com/knsh14/uber-style-guide-ja

https://github.com/knsh14/uber-style-guide-ja

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/knsh14/uber-style-guide-ja
• Owner: knsh14
• License: apache-2.0
• Created: 2019-10-19T10:18:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-11T07:53:36.000Z (about 3 years ago)
• Last Synced: 2025-03-29T10:27:54.126Z (about 1 year ago)
• Size: 70.3 KB
• Stars: 374
• Watchers: 7
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md# uber-style-guide-ja

https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md# About

[uber-go/guide]( https://github.com/uber-go/guide )の日本語訳

https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md# Table of Contents

- [導入](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#導入)

- [ガイドライン](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#ガイドライン)

  - [Pointers to Interfaces](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#pointers-to-interfaces)

  - [Verify Interface Compliance](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#verify-interface-compliance)

  - [Receivers and Interfaces](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#receivers-and-interfaces)

  - [Zero-value Mutexes are Valid](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#zero-value-mutexes-are-valid)

  - [Copy Slices and Maps at Boundaries](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#copy-slices-and-maps-at-boundaries)

    - [Receiving Slices and Maps](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#receiving-slices-and-maps)

    - [Returning Slices and Maps](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#returning-slices-and-maps)

  - [Defer to Clean Up](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#defer-to-clean-up)

  - [Channel Size is One or None](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#channel-size-is-one-or-none)

  - [Start Enums at One](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#start-enums-at-one)

  - [Use `"time"` to handle time](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-time-to-handle-time)

    - [Use `time.Time` for instants of time](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-timetime-for-instants-of-time)

    - [Use `time.Duration` for periods of time](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-timeduration-for-periods-of-time)

    - [Use `time.Time` and `time.Duration` with external systems](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-timetime-and-timeduration-with-external-systems)

  - [Errors](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#errors)

    - [Error Types](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#error-types)

    - [Error Wrapping](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#error-wrapping)

    - [Error Naming](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#error-naming)

    - [Handle Errors Once](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#handle-errors-once)

  - [Handle Type Assertion Failures](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#handle-type-assertion-failures)

  - [Don't Panic](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#dont-panic)

  - [Use go.uber.org/atomic](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-gouberorgatomic)

  - [Avoid Mutable Globals](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-mutable-globals)

  - [Avoid Embedding Types in Public Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-embedding-types-in-public-structs)

  - [Avoid Using Built-in Names](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-using-built-in-names)

  - [Avoid `init()`](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-init)

  - [Exit in Main](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#exit-in-main)

    - [Exit Once](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#exit-once)

  - [Use field tags in marshaled structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-field-tags-in-marshaled-structs)

  - [Don't fire-and-forget goroutines](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#dont-fire-and-forget-goroutines)

    - [Wait for goroutines to exit](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#wait-for-goroutines-to-exit)

    - [No goroutines in `init()`](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#no-goroutines-in-init)

- [Performance](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#performance)

  - [Prefer strconv over fmt](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#prefer-strconv-over-fmt)

  - [Avoid string-to-byte conversion](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-string-to-byte-conversion)

  - [Prefer Specifying Map Capacity Hints](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#prefer-specifying-map-capacity-hints)

- [Style](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#style)

  - [Avoid overly long lines](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-overly-long-lines)

  - [Be Consistent](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#be-consistent)

  - [Group Similar Declarations](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#group-similar-declarations)

  - [Import Group Ordering](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#import-group-ordering)

  - [Package Names](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#package-names)

  - [Function Names](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#function-names)

  - [Import Aliasing](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#import-aliasing)

  - [Function Grouping and Ordering](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#function-grouping-and-ordering)

  - [Reduce Nesting](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#reduce-nesting)

  - [Unnecessary Else](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#unnecessary-else)

  - [Top-level Variable Declarations](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#top-level-variable-declarations)

  - [Prefix Unexported Globals with \_](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#prefix-unexported-globals-with-_)

  - [Embedding in Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#embedding-in-structs)

  - [Local Variable Declarations](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#local-variable-declarations)

  - [nil is a valid slice](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#nil-is-a-valid-slice)

  - [Reduce Scope of Variables](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#reduce-scope-of-variables)

  - [Avoid Naked Parameters](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-naked-parameters)

  - [Use Raw String Literals to Avoid Escaping](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-raw-string-literals-to-avoid-escaping)

  - [Initializing Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#initializing-structs)

    - [Use Field Names to Initialize Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-field-names-to-initialize-structs)

    - [Omit Zero Value Fields in Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#omit-zero-value-fields-in-structs)

    - [Use `var` for Zero Value Structs](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#use-var-for-zero-value-structs)

    - [Initializing Struct References](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#initializing-struct-references)

  - [Initializing Maps](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#initializing-maps)

  - [Format Strings outside Printf](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#format-strings-outside-printf)

  - [Naming Printf-style Functions](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#naming-printf-style-functions)

- [Patterns](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#patterns)

  - [Test Tables](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#test-tables)

  - [Avoid Unnecessary Complexity in Table Tests](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#avoid-unnecessary-complexity-in-table-tests)

    - [Parallel Tests](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#parallel-tests)

  - [Functional Options](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#functional-options)

- [Linting](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#linting)

  - [Lint Runners](https://github.com/knsh14/uber-style-guide-ja/blob/master/guide.md#lint-runners)