standards-go

Guide Go code writing, review, and architecture with readability and maintainability standards.

2|Updated Apr 10, 2024
One-click install
npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-go
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: standards-go
Source: https://github.com/gdurandvadas/dotfiles/tree/main/config/opencode/skills/standards-go
Command: npx skills add https://github.com/gdurandvadas/dotfiles --skill standards-go

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This standards guide provides a centralized, actionable set of rules for writing and reviewing Go code, ensuring consistency, readability, and maintainability across projects.

Core Features & Use Cases

  • Idiomatic Go patterns, robust error handling, resource management, naming conventions, and API design guidance including generics and concurrency considerations.
  • Comprehensive references to established Go best-practices (Effective Go, CodeReviewComments, Uber/Google style guides) to support both day-to-day coding and architectural decisions.
  • Use cases include onboarding new contributors, performing code reviews, and guiding architectural decisions for Go projects of varying scopes.

Quick Start

Analyze your Go project against these standards and begin applying the patterns today.

Frequently Asked Questions about standards-go

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

FAQPage Schema
What are the best practices for idiomatic Go code formatting and linting?

Idiomatic Go formatting and linting best practices enforce consistent naming conventions, robust error handling, and resource management rules. This guide centralizes these standards by referencing Effective Go and CodeReviewComments to ensure project maintainability and readability.

How do I review Go code for consistency and maintainability?

Review Go code for consistency by checking formatting, error handling, naming, and API design against established standards. This guide provides actionable rules derived from Uber and Google style guides to support structured, reliable code reviews across varying project scopes.

Does this Go standards guide cover concurrency and generics API design?

Yes, this Go standards guide covers API design guidance including generics and concurrency considerations. It provides idiomatic patterns and architectural decision frameworks to handle these advanced features while maintaining code readability and robust resource management.

How do I onboard new contributors to Go project standards?

Onboard new contributors to Go project standards by providing a centralized, actionable set of rules for writing and reviewing code. This guide establishes consistent patterns for error handling, naming, and formatting to quickly align new developers with project expectations.

What is the best way to architect Go code for long-term maintainability?

Architect Go code for maintainability by applying idiomatic patterns, robust error handling, and structured API design rules. This guide references established best-practice sources like Effective Go to support both day-to-day coding and high-level architectural decisions.