SkillsAdd

lvtd-llc/skills

go-idiomatic-api-design

Design and review stable, idiomatic Go package APIs covering naming, exported declarations, embedding, receivers, typed-nil interfaces, generics, functional options, method sets, errors, wire contracts, compatibility, and examples.

Installation

$ npx skills add lvtd-llc/skills --skill go-idiomatic-api-design
View on skills.sh ↗ GitHub repository ↗

Summary

  • Design and review stable, idiomatic Go package APIs covering naming, exported declarations, embedding, receivers, typed-nil interfaces, generics, functional options, method sets, errors, wire contracts, compatibility, and examples.
  • Use when creating a reusable Go package, reviewing its public surface, evolving an exported API, or choosing concrete types, functions, methods, fields, interfaces, or type parameters.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

frontend-design Same topic
anthropics/skills

Guidance for distinctive, intentional visual design when building new UI or reshaping an existi…

866.4K installs
agent-browser Same topic
vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs
vercel-react-best-practices Same topic
vercel-labs/agent-skills 697.8K installs
web-design-guidelines Same topic
vercel-labs/agent-skills

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…

617.3K installs
microsoft-foundry Same topic
microsoft/azure-skills

Build, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …

576.5K installs
azure-diagnostics Same topic
microsoft/azure-skills

Debug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe …

568.9K installs

Also in this package

Other skills from lvtd-llc/skills · top by installs.

npx skills add lvtd-llc/skills
game-balance-economy 119 django-htmx 78 game-mechanics-design 74 calibredb 71 alpinejs-django 68 game-playtest-planning 67 game-story-world-character 67 book-toc-lab 66 b2b-sales-constraint-diagnosis 63 make-product-viral 63

Browse all from lvtd-llc/skills

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Declared
Cursor Not declared
Codex Declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 1
License LICENSE
Default branch main
Open issues 0
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Version0.2.0
LicenseMIT
CompatibilityCodex, Claude Code, and other Agent Skills-compatible clients.
Declared agents claude-code codex
More metadata
version
0.2.0
displayName
Go Idiomatic API Design
category
Go
tags
go,golang,api-design,packages,interfaces,compatibility

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,155 B
  • docs SUMMARY.md 447 B

History

  1. First recorded snapshot · 1 installs

SKILL.md

Go Idiomatic API Design

Design from the caller's code inward. Prefer the smallest coherent public surface that preserves invariants and can evolve without needless interfaces.

Core Workflow

  1. Identify callers, supported operations, and compatibility constraints.
  2. Sketch realistic call sites before choosing exported names or types.
  3. Keep packages cohesive and names clear without package-name stutter.
  4. Prefer concrete provider APIs; define narrow interfaces at consumers.
  5. Decide zero-value, mutation, copying, concurrency, and error contracts.
  6. Review embedding, receiver method sets, typed nils, generics, and option conflicts.
  7. Integrate standard interfaces only when their semantics truly match.
  8. Prove the public surface with external tests and executable examples.
  9. Review the change for accidental compatibility commitments.

Read Next

Task Load
Design or evolve an API guidelines.md, workflows/review-public-api.md
Choose types, fields, methods, or interfaces references/api-design/rules.md
Understand compatibility and method sets references/api-design/knowledge.md
Review concrete patterns references/api-design/examples.md

Guardrails

  • Do not export a field merely to avoid writing behavior.
  • Do not define a provider-wide interface as a mirror of its methods.
  • Do not accept an interface before a real consumer requires substitution.
  • Do not use a standard interface when its conventional semantics are surprising.
  • Do not claim conformance assertions prove behavior.
  • Do not embed a public type unless every promoted behavior is intentional.
  • Do not return a typed nil pointer through an interface success path.
  • Check the module's Go language version before giving version-sensitive advice.

Source Notes

Guidance is transformed and paraphrased from Inanc Gumus, Go by Example: Programmer's Guide to Idiomatic and Testable Programs (Manning, 2025), especially Chapters 1, 2, 5, 9, and 10. Examples are original.

Embedding, receivers, generics, functional options, and typed-nil guidance also incorporates transformed material from Teiva Harsanyi, 100 Go Mistakes and How to Avoid Them (Manning, 2022), Chapters 2 and 6.

Book: https://www.manning.com/books/go-by-example

Current language and documentation contracts should be verified against https://go.dev/ref/spec, https://go.dev/doc/comment, and the module's pinned Go version.