mcp-vosdroits: Instructions file for GitHub Copilot

---

description: 'Instructions for writing Go code following idiomatic Go practices and community standards' applyTo: '/*.go,/go.mod,**/go.sum'

Go Development Instructions

Follow idiomatic Go practices and community standards when writing Go code. These instructions are based on Effective Go, Go Code Review Comments, and Google's Go Style Guide.

General Instructions

• Write simple, clear, and idiomatic Go code
• Favor clarity and simplicity over cleverness
• Follow the principle of least surprise
• Keep the happy path left-aligned (minimize indentation)
• Return early to reduce nesting
• Prefer early return over if-else chains
• Make the zero value useful
• Write self-documenting code with clear, descriptive names
• Document exported types, functions, methods, and packages
• Use Go modules for dependency management
• Leverage the Go standard library instead of reinventing the wheel
• Write comments in English

Naming Conventions

Packages

• Use lowercase, single-word package names
• Avoid underscores, hyphens, or mixedCaps
• Choose names that describe what the package provides
• Avoid generic names like util, common, or base

Variables and Functions

• Use mixedCaps or MixedCaps (camelCase) rather than underscores
• Keep names short but descriptive
• Exported names start with a capital letter
• Unexported names start with a lowercase letter
• Avoid stuttering (e.g., avoid http.HTTPServer, prefer http.Server)

Interfaces

• Name interfaces with -er suffix when possible (e.g., Reader, Writer)
• Single-method interfaces should be named after the method
• Keep interfaces small and focused

Code Style and Formatting

• Always use gofmt to format code
• Use goimports to manage imports automatically
• Keep line length reasonable (no hard limit, but consider readability)
• Add blank lines to separate logical groups of code