go-pedantry

What problem does it solve?

This Skill enforces Go's idiomatic conventions and best practices, ensuring code consistency, maintainability, and adherence to community standards, thereby preventing common pitfalls and improving code quality.

Core Features & Use Cases

• Error Handling: Enforces correct error wrapping with fmt.Errorf and %w, and proper sentinel error naming.
• Interface Design: Guides users on creating small, focused interfaces, defining them at the consumer side, and adhering to the "accept interfaces, return structs" principle.
• Code Structure: Provides strict guidelines on package naming, struct field ordering, and receiver naming conventions.
• Tooling: Offers a recommended golangci-lint configuration for automated code analysis.
• Use Case: When writing a new Go service, use this Skill to ensure all error handling, interface definitions, and package structures align with Go's idiomatic style, making the codebase easier for other Go developers to understand and contribute to.

Quick Start

Use the go-pedantry skill to review the provided Go code for idiomatic correctness.