effective-go
应用来自golang.org/doc/effective_go的Go最佳实践、惯用和约定。在编写、审查或重构Go代码时使用,以确保符合惯用、简洁和高效的实现。
📖 中文导读:应用来自golang.org/doc/effective_go的Go最佳实践、惯用和约定。在编写、审查或重构Go代码时使用,以确保符合惯用、简洁和高效的实现。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: Effective Go description: "Apply Go best practices, idioms, and conventions from golang.org/doc/effective_go. Use when writing, reviewing, or refactoring Go code to ensure idiomatic, clean, and efficient implementations."
Effective Go
Apply best practices and conventions from the official Effective Go guide to write clean, idiomatic Go code.
When to Apply
Use this skill automatically when:
- Writing new Go code
- Reviewing Go code
- Refactoring existing Go implementations
Key Reminders
Follow the conventions and patterns documented at https://go.dev/doc/effective_go, with particular attention to:
- Formatting: Always use
gofmt- this is non-negotiable - Naming: No underscores, use MixedCaps for exported names, mixedCaps for unexported
- Error handling: Always check errors; return them, don't panic
- Concurrency: Share memory by communicating (use channels)
- Interfaces: Keep small (1-3 methods ideal); accept interfaces, return concrete types
- Documentation: Document all exported symbols, starting with the symbol name
References
- Official Guide: https://go.dev/doc/effective_go
- Code Review Comments: https://go.dev/wiki/CodeReviewComments
- Standard Library: Use as reference for idiomatic patterns
- Error Handling Reference: See
references/error-handling.mdfor comprehensive error handling patterns (wrapping, sentinel errors, custom types, testing)