Skills
.Work. You
Rest

go-api-review

Community

Improve Go package discoverability and DX

Software Engineering#code review#documentation#developer experience#go#godoc#api review
Authorarloliu
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps maintainers and evaluators quickly assess a Go package's developer experience by producing a focused, actionable review based only on the exported API (Godoc) and the README, without inspecting internal source code. It surfaces discoverability gaps, ambiguous interfaces, documentation omissions, and potential misuse risks so maintainers can prioritize improvements that matter to users.

Core Features & Use Cases

  • API-first review: Analyze exported types, functions, and interfaces for naming, single-responsibility, and idiomatic Go patterns.
  • Documentation & examples: Check package-level Godoc, examples, README clarity, and whether common flows are demonstrated and easy to follow.
  • Misuse and lifecycle checks: Highlight concurrency, lifecycle, error-handling, and contextual usage pitfalls that could lead to developer confusion or incorrect usage.

Quick Start

Review the parti Go package using only its exported Godoc and README and produce a prioritized, actionable developer-experience review covering interface design, documentation clarity, examples, error handling, concurrency guarantees, and potential misuse.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: go-api-review
Download link: https://github.com/arloliu/parti/archive/main.zip#go-api-review

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.