Overview

This repository provides essential guidelines for AI coding agents, empowering them to write modern, idiomatic Go code. By leveraging the latest language features and standard library enhancements, these guidelines help agents overcome common pitfalls like outdated patterns and training data lag, ensuring generated Go code is clean, efficient, and maintainable.

Key Features

• Comprehensive Go Version Support: Covers features from Go 1.0 through Go 1.27, specifically targeting modern idioms and the modernize analyzer's recommendations.
• Intelligent Feature Adoption: Agents automatically detect the project's Go version and utilize available language constructs and stdlib additions up to that version.
• Modern Idiom Prioritization: Explicitly guides agents to prefer contemporary Go patterns, such as max(a, b) over if-else, slices.Contains over manual loops, and cmp.Or(a, b, c) for nil checks.
• Type-Safe Error Handling: Promotes modern error handling with features like errors.AsType[T](err) for precise type matching (Go 1.26+).
• Pointer Convenience: Integrates newer syntaxes like new(42) for obtaining pointers directly (Go 1.26+).
• Seamless Agent Integration: Designed for easy integration with popular AI coding platforms like Junie, Claude Code, Codex, Cursor, and others via skills.sh.

Typical Use Cases

• New Go Project Generation: Ensure AI agents generate Go code that is immediately up-to-date with modern best practices, reducing the need for post-generation refactoring.
• Code Snippet Generation: AI assistants can provide more relevant and efficient Go code snippets, leveraging the latest language capabilities.
• Refactoring Assistance: Helps AI agents identify and suggest replacements for older Go patterns with their modern equivalents.
• Educational Tooling: Aids developers in understanding and adopting modern Go features by observing how AI agents are guided to use them.
• Team Collaboration: Standardizes the style and modernity of Go code produced by AI tools across development teams.