Individual skill

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. 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.

plugins/LVTD-LLC/skills/skills/go-idiomatic-api-design/SKILL.md

Read pinned source

Source commit d780783eba4ecc7c8b9429f95c9362df95f07c61

What was checked

Matches the observed repository HEAD: Yes
Scanner rules are current: Yes
Repository scan complete: No
Skill scan complete: No
Observed behavior: Network or broad shell
Last checked: Nov 4, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings): 1,532
Repository last updated: Nov 6, 2026
License: Apache-2.0

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

ai-coding Repository topic
awesome Repository topic
awesome-list Repository topic
codex Repository topic
codex-plugins Repository topic
openai Repository topic
codex-skill Repository topic
codex-skills Repository topic
marketplace Repository topic
codex-marketplace Repository topic
go,golang,api-design,packages,interfaces,compatibility Declared skill tag
design Derived category

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files

SKILL.mdcore · 3,155 bytes
agents/openai.yamlasset · 234 bytes
guidelines.mddoc · 1,851 bytes
references/api-design/examples.mddoc · 1,546 bytes
references/api-design/knowledge.mddoc · 3,896 bytes
references/api-design/rules.mddoc · 2,707 bytes
workflows/review-public-api.mddoc · 1,588 bytes

Read excerpt


# 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.