Install this skill
npx skills add openshift/hypershiftWorks across Claude Code, Cursor, Codex, Copilot & Antigravity
What this skill does
- β’Applies standard naming conventions for exported and internal symbols
- β’Validates error handling patterns and prevents improper panic usage
- β’Enforces interface minimalism by suggesting smaller method sets
- β’Standardizes documentation comments for all exported types and functions
- β’Automates formatting compliance to match the official gofmt standard
When to use it
- βReviewing pull requests for stylistic or idiomatic deviations
- βRefactoring monolithic packages into smaller, interface-driven components
- βOnboarding new team members to project-specific coding standards
- βPreparing internal packages for public release or long-term maintenance
When not to use it
- βWhen working in languages other than Go
- βWhen applying architectural changes that require non-idiomatic performance hacks for high-frequency low-latency paths
How to invoke it
Example prompts that trigger this skill:
- βRefactor this package to follow Effective Go conventions.β
- βReview this code and suggest changes to improve idiomatic Go usage.β
- βApply Go naming and error handling best practices to this file.β
- βIdentify non-idiomatic patterns in my current implementation.β
- βClean up this struct and interface design based on Effective Go.β
Example workflow
- Analyze the target Go file or directory for stylistic issues.
- Identify deviations from standard naming and error checking patterns.
- Execute refactoring suggestions to adhere to idiomatic interface designs.
- Verify the code against gofmt formatting standards.
- Generate documentation comments for all exported symbols.
Prerequisites
- βGo runtime environment installed locally
- βProject directory structured according to standard Go workspace conventions
Pitfalls & limitations
- !May suggest changes that break backward compatibility if applied to existing public APIs
- !Does not account for non-standard library performance optimizations required in highly specific hardware-interfacing code
FAQ
How it compares
Unlike a generic prompt, this skill is pre-configured with the specific constraints of the official Go style guide, ensuring consistent, reproducible results across your entire project.
Source & trust
From the source: β# Effective Go Apply best practices and conventions from the official [Effective Go guide](https://go.dev/doc/effective_go) to write clean, idiomatic Go code. ## When to Apply Use this skill automatically when: - Writing new Go code - Reviewing Go code - Refactoring existing Go implementations ## Keβ¦β
View the full SKILL.md source
# Effective Go Apply best practices and conventions from the official [Effective Go guide](https://go.dev/doc/effective_go) to write clean, idiomatic Go code. ## When to Apply Use this skill automatically when: - Writing new Go code - Reviewing Go code - Refactoring existing Go implementations ## Key Reminders Follow the conventions and patterns documented at https://go.dev/doc/effective_go, with particular attention to: - **Formatting**: Always use `gofmt` - this is non-negotiable - **Naming**: No underscores, use MixedCaps for exported names, mixedCaps for unexported - **Error handling**: Always check errors; return them, don't panic - **Concurrency**: Share memory by communicating (use channels) - **Interfaces**: Keep small (1-3 methods ideal); accept interfaces, return concrete types - **Documentation**: Document all exported symbols, starting with the symbol name ## References - Official Guide: https://go.dev/doc/effective_go - Code Review Comments: https://github.com/golang/go/wiki/CodeReviewComments - Standard Library: Use as reference for idiomatic patterns
Quoted from openshift/hypershift for reference β see the original for the authoritative, latest version.
π Full skill instructions β original source: openshift/hypershift
How to Use This Skill Unit
Option A: Project-Specific (Recommended)
- Click "Download" above
- In your project, create the directory:
.agent/skills/effective-go/ - Save the file as
SKILL.md - The agent will automatically discover the skill based on its description.
Option B: Global Installation (All Agents)
Save the file to these locations to make it available across all projects:
- Claude Code:
~/.claude/skills/openshift/hypershift/effective-go/SKILL.md - Cursor:
~/.cursor/skills/openshift/hypershift/effective-go/SKILL.md - Antigravity:
~/.gemini/antigravity/skills/openshift/hypershift/effective-go/SKILL.md
π Install with CLI:npx skills add openshift/hypershift