Files

Gabriel Radureau 9336178d73 📝 docs: add ADR for staged-only Git hooks formatting

- Add ADR-0012 documenting the decision to format only staged Go files
- Update ADR README.md with new entry
- Document rationale, alternatives, and verification results
- Include future considerations for monitoring and CI/CD integration

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>

2026-04-04 21:36:57 +02:00

0001-go-1.26.1-standard.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0002-chi-router.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0003-zerolog-logging.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0004-interface-based-design.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0005-graceful-shutdown.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0006-configuration-management.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0007-opentelemetry-integration.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0008-bdd-testing.md

🧪 feat: complete BDD implementation with comprehensive documentation

2026-04-04 17:59:35 +02:00

0009-hybrid-testing-approach.md

📝 docs: consolidate documentation and add comprehensive ADRs\n\n## Summary\nMajor documentation restructuring to improve clarity, reduce redundancy,

2026-04-04 15:48:27 +02:00

0010-agent-configuration-relationship.md

📝 docs: add agent configuration ADR and compact CHANGELOG

2026-04-04 20:03:30 +02:00

0010-api-v2-feature-flag.md

✨ feat: implement API v2 with feature flag control

2026-04-04 20:39:46 +02:00

0011-validation-library-selection.md

✨ feat: implement input validation for API v2

2026-04-04 21:08:13 +02:00

0012-git-hooks-staged-only-formatting.md

📝 docs: add ADR for staged-only Git hooks formatting

2026-04-04 21:36:57 +02:00

README.md

📝 docs: add ADR for staged-only Git hooks formatting

2026-04-04 21:36:57 +02:00

README.md

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records (ADRs) for the DanceLessonsCoach project.

What is an ADR?

An ADR is a document that captures an important architectural decision made along with its context and consequences.

Format

Each ADR follows this structure:

# [Short title is a few words]

* Status: [Proposed | Accepted | Deprecated | Superseded]
* Deciders: [List of decision makers]
* Date: [YYYY-MM-DD]

## Context and Problem Statement

[Describe the context and problem statement]

## Decision Drivers

* [Driver 1]
* [Driver 2]
* [Driver 3]

## Considered Options

* [Option 1]
* [Option 2]
* [Option 3]

## Decision Outcome

Chosen option: "[Option 1]" because [justification]

## Pros and Cons of the Options

### [Option 1]

* Good, because [argument a]
* Good, because [argument b]
* Bad, because [argument c]

### [Option 2]

* Good, because [argument a]
* Good, because [argument b]
* Bad, because [argument c]

## Links

* [Link type] [Link to ADR]
* [Link type] [Link to ADR]

ADR List

0001-go-1.26.1-standard.md - Use Go 1.26.1 as the standard Go version
0002-chi-router.md - Use Chi router for HTTP routing
0003-zerolog-logging.md - Use Zerolog for structured logging
0004-interface-based-design.md - Adopt interface-based design pattern
0005-graceful-shutdown.md - Implement graceful shutdown with readiness endpoints
0006-configuration-management.md - Use Viper for configuration management
0007-opentelemetry-integration.md - Integrate OpenTelemetry for distributed tracing
0008-bdd-testing.md - Adopt BDD with Godog for behavioral testing
0009-hybrid-testing-approach.md - Combine BDD and Swagger-based testing
0010-api-v2-feature-flag.md - API v2 implementation with feature flag control
0011-validation-library-selection.md - Selection of go-playground/validator for input validation
0012-git-hooks-staged-only-formatting.md - Git hooks format only staged Go files

How to Add a New ADR

Create a new file with the next available number (e.g., 0010-new-decision.md)
Follow the template format
Update this README.md with the new ADR
Commit the changes

Status Legend

Proposed: Decision is being discussed
Accepted: Decision has been made and implemented
Deprecated: Decision is no longer relevant
Superseded: Decision has been replaced by another ADR