review-go

Reviews Go packages against project naming, architecture, and workflow guidelines and reports violations.

5|Updated Sep 9, 2017
One-click install
npx skills add https://github.com/hpcsc/dotfiles --skill review-go-hpcsc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-go
Source: https://github.com/hpcsc/dotfiles/tree/main/link/common/claude/.claude/skills/review-go
Command: npx skills add https://github.com/hpcsc/dotfiles --skill review-go-hpcsc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Go codebases drift from team conventions over time, and manually auditing packages for naming, architecture, and structure violations is slow and inconsistent. This Skill automates that audit by checking a Go package against the project's documented guidelines and producing a structured findings report. ## Core Features & Use Cases - Naming Pattern Checks: Verifies package names are domain nouns, interface names read naturally with the package name, and file and constructor names follow Go conventions. - Architecture Review: Checks dependency inversion, constructor injection, interface size, and interface ownership against project principles. - Workflow Convention Audit: Confirms constructor return types, interface compliance checks, test double co-location, and package organization. - Use Case: After writing a new command package with an in-memory implementation, run the review to catch issues like a redundant CommandBus interface name or a missing var _ Interface = (*impl)(nil) compliance check before opening a pull request. ## Quick Start Ask the AI to review the Go package at ./internal/command for adherence to the project Go guidelines.

Frequently Asked Questions about review-go

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a Go package against project coding guidelines?▼

Invoke the review with a package path as the argument, either a relative path resolved from the current directory or a Go import path. The review reads the guideline files, maps the package structure, and reports each violation with file, line, guideline reference, and a concrete fix.

What naming conventions does a Go package review check?▼

It checks that package names are domain nouns rather than technical names like util or manager, that interface names read naturally with the package name such as command.Bus, and that file and constructor names are descriptive and follow NewX conventions.

Does the Go review check for logic bugs or test quality?▼

No, logic bugs and test quality are explicitly out of scope and handled by a separate test review skill. It also skips security, performance, concurrency issues, third-party dependencies, and style preferences not covered by the guidelines.

What architecture principles are verified in a Go code review?▼

The review verifies dependency inversion so high-level modules depend on interfaces, constructor injection rather than internal creation of dependencies, small focused role interfaces, and correct interface ownership for external versus pluggable infrastructure dependencies.

What output does the Go package review produce?▼

It produces a Markdown report with a structure summary, numbered findings listing issue, guideline, and fix per violation, and a final verdict of PASS or NEEDS WORK with the top three priority fixes when violations exist.