Gabriel Radureau
95596b5e12
and preserve complete architectural context for AI/developer reference.\n\n## Changes\n\n### Documentation Consolidation 🗂️\n- Simplified README.md by ~100 lines (25% reduction)\n- Removed redundant sections (project structure, configuration, API docs)\n- Added strategic cross-references between README.md and AGENTS.md\n- README.md now focused on user onboarding and basic usage\n- AGENTS.md maintained as complete technical reference\n\n### Architecture Decision Records ✅\n- Added comprehensive ADR directory with 9 decision records:\n * 0001-go-1.26.1-standard.md\n * 0002-chi-router.md\n * 0003-zerolog-logging.md (enhanced with Zap analysis)\n * 0004-interface-based-design.md\n * 0005-graceful-shutdown.md\n * 0006-configuration-management.md\n * 0007-opentelemetry-integration.md\n * 0008-bdd-testing.md\n * 0009-hybrid-testing-approach.md\n- Added adr/README.md with guidelines and template\n- Enhanced Zerolog ADR with detailed performance benchmarking vs Zap\n\n### Content Organization 📝\n- README.md: User-focused guide with quick start and basic examples\n- AGENTS.md: Developer/AI-focused complete technical reference\n- ADR directory: Architectural decision history and rationale\n\n## Impact\n- ✅ Better user onboarding experience\n- ✅ Preserved complete technical context for AI agents\n- ✅ Reduced maintenance burden through consolidation\n- ✅ Improved discoverability of advanced documentation\n- ✅ Established ADR process for future decisions\n\n## Related\n- Resolves documentation redundancy issues\n- Prepares for BDD implementation with clear context\n- Supports future Swagger integration decisions\n- Maintains project history for new contributors\n\nGenerated by Mistral Vibe.\nCo-Authored-By: Mistral Vibe <vibe@mistral.ai>
57 lines
1.5 KiB
Markdown
57 lines
1.5 KiB
Markdown
# Use Go 1.26.1 as the standard Go version
|
|
|
|
* Status: Accepted
|
|
* Deciders: Gabriel Radureau, AI Agent
|
|
* Date: 2026-04-01
|
|
|
|
## Context and Problem Statement
|
|
|
|
We needed to choose a Go version for the DanceLessonsCoach project that provides:
|
|
- Stability and long-term support
|
|
- Access to modern language features
|
|
- Good ecosystem compatibility
|
|
- Security updates
|
|
|
|
## Decision Drivers
|
|
|
|
* Project requires modern Go features
|
|
* Need for good dependency compatibility
|
|
* Desire for long-term support
|
|
* Team familiarity with recent Go versions
|
|
|
|
## Considered Options
|
|
|
|
* Go 1.25.x - Latest stable version at project start
|
|
* Go 1.26.1 - Newer version with additional features
|
|
* Go 1.24.x - More widely adopted but older
|
|
|
|
## Decision Outcome
|
|
|
|
Chosen option: "Go 1.26.1" because it provides the best balance of modern features, stability, and ecosystem support.
|
|
|
|
## Pros and Cons of the Options
|
|
|
|
### Go 1.26.1
|
|
|
|
* Good, because provides access to latest language improvements
|
|
* Good, because includes recent security fixes
|
|
* Good, because has better performance optimizations
|
|
* Bad, because slightly less battle-tested than older versions
|
|
|
|
### Go 1.25.x
|
|
|
|
* Good, because widely adopted
|
|
* Good, because very stable
|
|
* Bad, because missing some newer features
|
|
* Bad, because would need upgrade sooner
|
|
|
|
### Go 1.24.x
|
|
|
|
* Good, because extremely stable
|
|
* Bad, because lacks modern features
|
|
* Bad, because security updates ending soon
|
|
|
|
## Links
|
|
|
|
* [Go 1.26 Release Notes](https://go.dev/doc/go1.26)
|
|
* [Go Downloads](https://go.dev/dl/) |