go/go-micro
1
0
Fork 0
mirror of https://github.com/go-micro/go-micro.git synced 2025-11-23 21:44:41 +02:00
Code Issues Releases Activity
Files
8cda829320a7911c8b2814365e4645d991936edd
go-micro/internal/website/docs/architecture/index.md
Asim Aslam 8cda829320 major docs overhaul
2025-11-13 18:34:40 +00:00

1.4 KiB
Raw Blame History

layout
layout
default

Architecture Decision Records

Documentation of architectural decisions made in Go Micro, following the ADR pattern.

What are ADRs?

Architecture Decision Records (ADRs) capture important architectural decisions along with their context and consequences. They help understand why certain design choices were made.

Index

Available

Planned

Core Design

  • ADR-002: Interface-First Design
  • ADR-003: Default Implementations

Service Discovery

  • ADR-005: Registry Plugin Scope

Communication

  • ADR-006: HTTP as Default Transport
  • ADR-007: Content-Type Based Codecs

Configuration

  • ADR-008: Environment Variable Support

Status Values

  • Proposed: Under consideration
  • Accepted: Decision approved
  • Deprecated: No longer recommended
  • Superseded: Replaced by another ADR

Contributing

To propose a new ADR:

  1. Number it sequentially (check existing ADRs)
  2. Follow the structure of existing ADRs
  3. Include: Status, Context, Decision, Consequences, Alternatives
  4. Submit a PR for discussion
  5. Update status based on review

ADRs are immutable once accepted. To change a decision, create a new ADR that supersedes the old one.