Welcome to a modern Go codebase.
This library follows best-in-class practices for clarity, performance, and maintainability.
We adhere to the patterns and philosophy in Effective Go.
Stick to idiomatic code. Avoid cleverness when clarity wins.
Everything lives in our AGENTS.md file. Read it. Bookmark it. Trust it.
Here’s a quick overview of what you'll find:
- Directory structure and related governance docs
- Naming conventions for code and files
- Commenting standards and templates
- Development, testing, and coverage standards
- Error handling practices in Go
- Commit and branch naming conventions
- Pull request conventions and required sections
- Labeling conventions for GitHub issues/PRs
- Build system and tooling overview
- And more!
This is intended for AI agents like GPT and Claude, but also for us human developers too!
When in doubt, check the official docs:
- ✨ Effective Go
- ⚖️ Go Benchmarks
- 📖 Go Examples
- ✅ Go Testing Guide
- 📃 godoc
- 🔧 gofmt
- 📊 golangci-lint
- 📈 Go Report Card
Happy coding — keep it clean, idiomatic, and readable. ✨