Index of every page on this site: llms.txt
All skills
openshift avatar

/effective-go

@0f43b29 official
by openshiftopenshift/hypershift555 stars
592
Run it yourself

Apply Go best practices, idioms, and conventions from golang.org/doc/effective_go. Use when writing, reviewing, or refactoring Go code to ensure idiomatic, clean, and efficient implementations.

Use this Skill: https://skilld.dev/gh/openshift/hypershift/effective-go

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈52 tokens for metadata: the name and description. ≈273 when used: this file.

Description uses 2.6% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈208 characters, or 2.6%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Effective Go

Apply best practices and conventions from the official Effective Go guide 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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning17d5 checks · Risk SAFE
  • Gen Agent Trust Hub17d

    This skill is a collection of coding guidelines and best practices for the Go programming language. It contains no executable code, external dependencies, or security risks. It serves as a reference for writing idiomatic and clean Go code.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW · No issues

  • Runlayer9mo

    1/1 file flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 0f43b29. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 5 days ago
  • Go
  • golang
  • best-practices
  • code-review
  • idioms
  • formatting
  • naming-conventions
  • error-handling
  • concurrency
  • interfaces

README badge

README badge for openshift/hypershift/effective-go

Applies Go idioms and conventions from the official Effective Go guide during code writing, review, and refactoring. Enforces gofmt formatting, naming conventions (MixedCaps/mixedCaps), error handling patterns, channel-based concurrency, small interfaces, and documentation standards.

Generated from the current SKILL.md.

Does this skill enforce gofmt automatically?
No. The skill reminds you to use gofmt as a requirement, but doesn't run it—you or your agent must apply gofmt explicitly.
Does this cover the entire Effective Go guide?
Yes. The skill references the full guide at golang.org/doc/effective_go and emphasizes key areas: formatting, naming, error handling, concurrency, interfaces, and documentation.
Can I use this skill for code review?
Yes. The skill is designed to be applied when reviewing Go code to ensure implementations follow idiomatic conventions and best practices.
Does this skill provide linting or static analysis?
No. It's an instruction guide for applying Go conventions manually. Use separate linting tools like golangci-lint for automated checks.

Generated from the current SKILL.md. These answers refresh after source changes.