testdino-hq/google-styleguides-skills

go

Google's official Go style guide.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/testdino-hq/google-styleguides-skills --skill go

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

Google Go Style Guide

Official Google Go coding standards for idiomatic, maintainable code.

Golden Rules

  1. Run `gofmt` before commit — formatting is non-negotiable
  2. Short variable names in small scopes — i, err, ctx
  3. Error handling, not exceptions — check every error
  4. Interfaces for abstraction — accept interfaces, return structs
  5. Defer for cleanup — ensure resources are released
  6. Explicit is better — avoid magic, prefer clarity
  7. Package names: lowercase, single word — no underscores

Quick Reference

Naming Conventions

ElementConventionExample
Packageslowercasepackage user
Fileslowercase_underscoreuser_service.go
TypesUpperCamelCaseUserService
Functions/MethodsUpperCamelCase (exported)GetUser
Functions/MethodslowerCamelCase (unexported)getUserByID
VariableslowerCamelCaseuserCount
ConstantsUpperCamelCase or UPPER_SNAKEMaxRetries
InterfacesUpperCamelCase + -er suffixReader, Writer

Variables

go
// ✓ CORRECT - short names in small scopes
for i := 0; i < 10; i++ {
    // ...
}

// ✓ CORRECT - descriptive names in larger scopes
func ProcessUserData(userRepository UserRepository) error {
    // ...
}

// ✗ INCORRECT - unnecessarily long
for index := 0; index < 10; index++ {
    // ...
}

Error Handling

go
// ✓ CORRECT - check every error
user, err := getUser(id)
if err != nil {
    return nil, fmt.Errorf("failed to get user: %w", err)
}

// ✗ INCORRECT - ignoring errors
user, _ := getUser(id)

Functions

go
// ✓ CORRECT - multiple return values
func GetUser(id int) (*User, error) {
    // ...
}

// ✓ CORRECT - named return values for clarity
func ParseConfig(path string) (cfg *Config, err error) {
    // ...
}

Interfaces

go
// ✓ CORRECT - small, focused interfaces
type Reader interface {
    Read(p []byte) (n int, err error)
}

// ✓ CORRECT - accept interfaces, return structs
func ProcessData(r Reader) (*Result, error) {
    // ...
}

Defer

go
// ✓ CORRECT - defer for cleanup
func ReadFile(path string) ([]byte, error) {
    f, err := os.Open(path)
    if err != nil {
        return nil, err
    }
    defer f.Close()
    
    return io.ReadAll(f)
}

Goroutines and Channels

go
// ✓ CORRECT - use context for cancellation
func ProcessItems(ctx context.Context, items []Item) error {
    for _, item := range items {
        select {
        case <-ctx.Done():
            return ctx.Err()
        default:
            if err := process(item); err != nil {
                return err
            }
        }
    }
    return nil
}

// ✓ CORRECT - buffered channels when appropriate
results := make(chan Result, len(items))

Package Organization

go
// ✓ CORRECT - package comment
// Package user provides user management functionality.
package user

// ✓ CORRECT - group imports
import (
    "context"
    "fmt"
    
    "github.com/pkg/errors"
    
    "myapp/internal/db"
)

Common Mistakes

MistakeCorrect Approach
Ignoring errorsCheck every error
Long variable names in loopsUse short names (i, j)
Panic for normal errorsReturn errors
Naked returnsUse explicit returns
Not running gofmtAlways format code
Underscores in package namesUse single lowercase word

When to Use This Guide

  • Writing new Go code
  • Refactoring existing Go
  • Code reviews
  • Setting up linting rules (golangci-lint)
  • Onboarding new team members

Install

bash
npx skills add testdino-hq/google-styleguides-skills/go

Full Guide

See go.md for complete details, examples, and edge cases.

관련 작업