Skip to content

dwisiswant0/go-llms

Repository files navigation

Go Programming Context for LLMs
=====

This repo contains a curated collection of Go
programming resources specifically formatted to
provide comprehensive context to Large Language
Models (LLMs) when assisting with Go dev tasks.

Contents
====

Core Go Documentation
===

* effective-go.txt - Official Go best practices
  and idiomatic programming patterns.
* go101.txt - Comprehensive Go language reference
  covering syntax, concepts, and advanced
  features.
* go-dev-doc.txt - Go development documentation
  and tooling information.

Best Practices & Common Pitfalls
===

* go-advice.txt - Curated collection of Go
  programming tips, tricks, and recommendations.
* 100-go-mistakes.txt - Common Go programming
  errors and anti-patterns to avoid.

Design Patterns
===

* design-patterns-go.txt - Go-specific
  implementations of standard design patterns.

Coding Style Guidelines
===

* styles/uber-go-style.md - Uber's comprehensive
  Go style guide for production code.
* styles/thanos-io-coding-style-guide.md - Thanos
  project's Go coding conventions.

Purpose
====

This collection serves as a knowledge base for
LLMs to provide accurate, idiomatic, and
best-practice Go programming assistance. The
resources cover language fundamentals, common
patterns, style conventions, and error prevention
to ensure high-quality Go code generation and
recommendations.

LLM Usage
====

These files provide essential context for:

* Writing idiomatic Go code following established
  conventions.
* Avoiding common mistakes and anti-patterns.
* Implementing proper design patterns and
  architectural decisions.
* Following industry-standard style guidelines.
* Understanding Go-specific concepts and best
  practices.

About

curated Go resources to provide comprehensive context to LLMs.

Topics

Resources

Stars

Watchers

Forks