go-best-practices
Production Go patterns — lifecycle, concurrency, config, testing, CI. Use when writing, reviewing, or refactoring Go code. Triggers on Go code review, Go refactoring, or 'go best practices'.
来源信息
- 仓库
- poteto/noodle
- 最近来源活动
- 2026年3月19日 04:43
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 277
- 分支
- 16
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
文件资源管理器
2 个文件正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- go-best-practices
- description
- Production Go patterns — lifecycle, concurrency, config, testing, CI. Use when writing, reviewing, or refactoring Go code. Triggers on Go code review, Go refactoring, or 'go best practices'.
# Go Best Practices
| Pattern | When to apply |
|---------|---------------|
| Minimal main | New binaries |
| Single bootstrap | App wiring across modes |
| Ordered shutdown | Long-running processes |
| Non-blocking fanout | Channel-based event systems |
| Concurrency testing | Any goroutine code |
| Layered config | Multi-source configuration |
| Cross-platform paths | File/config path resolution |
| Secure debug logging | HTTP client instrumentation |
| Golden test matrices | Rendering / output components |
| Focused linters | CI pipeline setup |
Read [references/patterns.md](references/patterns.md) for code examples.
## Rules
1. **main.go is a stub.** Call `cmd.Execute()` and nothing else. Gate
diagnostics (pprof) behind env vars.
2. **One bootstrap path.** All modes (interactive, headless, test) share the
same initialization function. Two paths will drift.
3. **Ordered shutdown.** Cancel dependents before their dependencies, then run
independent cleanup in parallel under a timeout context. WaitGroup the
parallel phase.
4. **Never block the sender.** Non-blocking channel sends with an explicit
drop policy. Log drops at debug level. Document the policy.
5. **Test concurrency mechanically.** `testing/synctest` for deterministic
timing, `goleak.VerifyNone` for leak detection, dedicated regression tests
for timer/channel deadlocks.
6. **Explicit config precedence.** Global → project → flags. Walk up from CWD
to discover project configs, reverse so closest wins, deep-merge.
7. **Centralize platform paths.** One function per concern. Resolution order:
env override → XDG → platform default → fallback.
8. **Redact secrets in debug logs.** Wrap `http.RoundTripper`. Filter headers
matching authorization, api-key, token, secret. Gate on debug level to
skip allocation in prod.
9. **Golden tests over matrices.** Cross dimensions (layout × theme × size)
as parallel subtests. Sweep continuous ranges to catch off-by-one bugs.
10. **Focused linters, not all linters.** Enable what catches real bugs
(bodyclose, noctx, tparallel). Disable noisy defaults. Add project-specific
checks as scripts. Always `-race` in tests.
在 GitHub 查看