arcodange/dance-lessons-coach
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

📝 docs(adr): homogenize 23 ADRs + rewrite README (Tâche 7 migration) #18

Merged
arcodange merged 2 commits from feature/homogenize-adrs into main 2026-05-03 11:01:14 +02:00
Conversation 0 Commits 2 Files Changed 22 +76 -92
1 changed files with 76 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit d64ab02e8b - Show all commits

168
adr/README.md
View File

@@ -1,129 +1,113 @@
# Architecture Decision Records (ADRs) # Architecture Decision Records (ADRs)
This directory contains Architecture Decision Records (ADRs) for the dance-lessons-coach project. This directory contains the Architecture Decision Records (ADRs) for the dance-lessons-coach project. Each ADR captures a structurally important decision, its context, and its consequences.
## Index of ADRs ## Index
| Number | Title | Status | | ADR | Title | Status |
|--------|-------|--------| |-----|-------|--------|
| 0001 | Go 1.26.1 Standard | ✅ Accepted | | [0001](0001-go-1.26.1-standard.md) | Use Go 1.26.1 as the standard Go version | Accepted |
| 0002 | Chi Router | ✅ Accepted | | [0002](0002-chi-router.md) | Use Chi router for HTTP routing | Accepted |
| 0003 | Zerolog Logging | ✅ Accepted | | [0003](0003-zerolog-logging.md) | Use Zerolog for structured logging | Accepted |
| 0004 | Interface-Based Design | ✅ Accepted | | [0004](0004-interface-based-design.md) | Adopt interface-based design pattern | Accepted |
| 0005 | Graceful Shutdown | ✅ Accepted | | [0005](0005-graceful-shutdown.md) | Implement graceful shutdown with readiness endpoints | Accepted |
| 0006 | Configuration Management | ✅ Accepted | | [0006](0006-configuration-management.md) | Use Viper for configuration management | Accepted |
| 0007 | OpenTelemetry Integration | ✅ Accepted | | [0007](0007-opentelemetry-integration.md) | Integrate OpenTelemetry for distributed tracing | Accepted |
| 0008 | BDD Testing | ✅ Accepted | | [0008](0008-bdd-testing.md) | Adopt BDD with Godog for behavioral testing | Accepted |
| 0009 | Hybrid Testing Approach | ✅ Accepted | | [0009](0009-hybrid-testing-approach.md) | Combine BDD and Swagger-based testing | Partially Implemented |
| 0010 | CI/CD Pipeline Design | ✅ Accepted | | [0010](0010-api-v2-feature-flag.md) | API v2 Feature Flag Implementation | Accepted |
| 0011 | Trunk-Based Development | ✅ Accepted | | [0012](0012-git-hooks-staged-only-formatting.md) | Git Hooks: Staged-Only Formatting | Accepted |
| 0012 | Commit Message Conventions | ✅ Accepted | | [0013](0013-openapi-swagger-toolchain.md) | OpenAPI/Swagger Toolchain Selection | Partially Implemented |
| 0013 | Version Management Lifecycle | ✅ Accepted | | [0015](0015-cli-subcommands-cobra.md) | CLI Subcommands and Flag Management with Cobra | Implemented |
| 0014 | Swagger Documentation | ✅ Accepted | | [0016](0016-ci-cd-pipeline-design.md) | CI/CD Pipeline Design for Multi-Platform Compatibility | Accepted |
| 0015 | Rate Limiting Strategy | ✅ Accepted | | [0017](0017-trunk-based-development-workflow.md) | Trunk-Based Development Workflow for CI/CD Safety | Approved |
| 0016 | Cache Invalidation Strategy | ✅ Accepted | | [0018](0018-user-management-auth-system.md) | User Management and Authentication System | Proposed |
| 0017 | JWT Secret Rotation | ✅ Accepted | | [0019](0019-postgresql-integration.md) | PostgreSQL Database Integration | Proposed |
| 0018 | Configuration Hot Reloading | ✅ Accepted | | [0020](0020-docker-build-strategy.md) | Docker Build Strategy: Traditional vs Buildx | Accepted |
| 0019 | BDD Feature Structure | ✅ Accepted | | [0021](0021-jwt-secret-retention-policy.md) | JWT Secret Retention Policy | Proposed |
| 0020 | Database Migration Strategy | ✅ Accepted | | [0022](0022-rate-limiting-cache-strategy.md) | Rate Limiting and Cache Strategy | Proposed |
| 0021 | API Versioning Strategy | ✅ Accepted | | [0023](0023-config-hot-reloading.md) | Config Hot Reloading Strategy | Proposed |
| 0022 | Rate Limiting and Cache Strategy | ✅ Accepted | | [0024](0024-bdd-test-organization-and-isolation.md) | BDD Test Organization and Isolation Strategy | Proposed |
| 0023 | Config Hot Reloading | 🟡 Proposed | | [0025](0025-bdd-scenario-isolation-strategies.md) | BDD Scenario Isolation Strategies | Proposed |
| 0024 | BDD Test Organization and Isolation | 🟡 Proposed |
| 0025 | BDD Scenario Isolation Strategies | 🟡 Proposed | > **Note** : numbers `0011` and `0014` are not currently in use. Reserved for future ADRs or representing previously deleted entries.
## What is an ADR? ## What is an ADR?
An ADR is a document that captures an important architectural decision made along with its context and consequences. An ADR is a document capturing one significant architectural decision: the **context** that motivated it, the **decision** itself, and its **consequences**. ADRs are append-only — once published, an ADR is not edited (except for typo / status updates). New decisions that supersede previous ones are recorded as new ADRs that explicitly link back.
## Format ## Canonical Format
Each ADR follows this structure: All ADRs follow the canonical format below (homogenized 2026-05-03):
```markdown ```markdown
# [Short title is a few words] # NN. Short title summarising the decision
* Status: [Proposed | Accepted | Deprecated | Superseded] **Status:** <Proposed | Accepted | Implemented | Partially Implemented | Approved | Rejected | Deferred | Deprecated | Superseded by ADR-NNNN>
* Deciders: [List of decision makers] **Date:** YYYY-MM-DD
* Date: [YYYY-MM-DD] **Authors:** Name(s)
[Optional fields, all in `**Field:** value` format:]
**Decision Drivers:** ...
**Implementation Status:** ...
**Implementation Date:** ...
**Last Updated:** ...
## Context and Problem Statement ## Context and Problem Statement
[Describe the context and problem statement] [Describe the context and problem statement.]
## Decision Drivers ## Decision Drivers
* [Driver 1] * Driver 1
* [Driver 2] * Driver 2
* [Driver 3]
## Considered Options ## Considered Options
* [Option 1] * Option 1
* [Option 2] * Option 2
* [Option 3]
## Decision Outcome ## Decision Outcome
Chosen option: "[Option 1]" because [justification] Chosen option: "Option 1" because [justification].
## Pros and Cons of the Options ## Pros and Cons of the Options
### [Option 1] ### Option 1
* Good, because [argument a] * Good, because [argument].
* Good, because [argument b] * Bad, because [argument].
* Bad, because [argument c]
### [Option 2] ### Option 2
* Good, because [argument a] * Good, because [argument].
* Good, because [argument b] * Bad, because [argument].
* Bad, because [argument c]
## Links ## Links
* [Link type] [Link to ADR] * Related ADR: [ADR-NNNN](NNNN-slug.md)
* [Link type] [Link to ADR] * Issue: [#NN](https://gitea.arcodange.lab/arcodange/dance-lessons-coach/issues/NN)
``` ```
## ADR List
* [0001-go-1.26.1-standard.md](0001-go-1.26.1-standard.md) - Use Go 1.26.1 as the standard Go version
* [0002-chi-router.md](0002-chi-router.md) - Use Chi router for HTTP routing
* [0003-zerolog-logging.md](0003-zerolog-logging.md) - Use Zerolog for structured logging
* [0004-interface-based-design.md](0004-interface-based-design.md) - Adopt interface-based design pattern
* [0005-graceful-shutdown.md](0005-graceful-shutdown.md) - Implement graceful shutdown with readiness endpoints
* [0006-configuration-management.md](0006-configuration-management.md) - Use Viper for configuration management
* [0007-opentelemetry-integration.md](0007-opentelemetry-integration.md) - Integrate OpenTelemetry for distributed tracing
* [0008-bdd-testing.md](0008-bdd-testing.md) - Adopt BDD with Godog for behavioral testing
* [0009-hybrid-testing-approach.md](0009-hybrid-testing-approach.md) - Combine BDD and Swagger-based testing
* [0010-api-v2-feature-flag.md](0010-api-v2-feature-flag.md) - API v2 implementation with feature flag control
* [0011-validation-library-selection.md](0011-validation-library-selection.md) - Selection of go-playground/validator for input validation
* [0012-git-hooks-staged-only-formatting.md](0012-git-hooks-staged-only-formatting.md) - Git hooks format only staged Go files
* [0013-openapi-swagger-toolchain.md](0013-openapi-swagger-toolchain.md) - ✅ OpenAPI/Swagger documentation with swaggo/swag (Implemented)
* [0014-grpc-adoption-strategy.md](0014-grpc-adoption-strategy.md) - Hybrid REST/gRPC adoption strategy
* [0015-cli-subcommands-cobra.md](0015-cli-subcommands-cobra.md) - Cobra CLI framework adoption
* [0016-ci-cd-pipeline-design.md](0016-ci-cd-pipeline-design.md) - CI/CD pipeline architecture
* [0017-trunk-based-development-workflow.md](0017-trunk-based-development-workflow.md) - Trunk-based development workflow
* [0018-user-management-auth-system.md](0018-user-management-auth-system.md) - User management and authentication system
* [0019-postgresql-integration.md](0019-postgresql-integration.md) - PostgreSQL database integration
* [0020-docker-build-strategy.md](0020-docker-build-strategy.md) - Docker Build Strategy: Traditional vs Buildx
* [0021-jwt-secret-retention-policy.md](0021-jwt-secret-retention-policy.md) - JWT Secret Retention Policy with Configurable TTL and Retention
* [0022-rate-limiting-cache-strategy.md](0022-rate-limiting-cache-strategy.md) - Rate Limiting and Cache Strategy with Multi-Phase Implementation
* [0023-config-hot-reloading.md](0023-config-hot-reloading.md) - Config Hot Reloading Strategy
* [0025-bdd-scenario-isolation-strategies.md](0025-bdd-scenario-isolation-strategies.md) - Schema-per-scenario isolation for BDD tests
## How to Add a New ADR
1. Create a new file with the next available number (e.g., `0010-new-decision.md`)
2. Follow the template format
3. Update this README.md with the new ADR
4. Commit the changes
## Status Legend ## Status Legend
* **Proposed**: Decision is being discussed | Status | Meaning |
* **Accepted**: Decision has been made and implemented |---|---|
* **Deprecated**: Decision is no longer relevant | **Proposed** | Decision is being discussed; no implementation yet. |
* **Superseded**: Decision has been replaced by another ADR | **Accepted** | Decision has been made; implementation may be pending or in progress. |
| **Approved** | Same as Accepted; alternative term used in some legacy ADRs. |
| **Implemented** | Decision is fully implemented and in production. |
| **Partially Implemented** | Decision is partly implemented; remainder is deferred or pending. |
| **Rejected** | Decision considered and explicitly rejected. The ADR documents why. |
| **Deferred** | Decision postponed; revisit later. |
| **Deprecated** | Decision is no longer relevant; system has moved on. |
| **Superseded by ADR-NNNN** | Decision has been replaced by another ADR. Always include the link. |
## How to Add a New ADR
1. Pick the next available number (currently next would be `0026`).
2. Copy an existing ADR (e.g., `0001-go-1.26.1-standard.md`) as a starting template.
3. Edit the title, status, date, authors, and content.
4. Update this `README.md` index with the new ADR.
5. Commit using gitmoji convention (e.g., `📝 docs(adr): add ADR-0026 about ...`).
6. Open a PR for review.