go-micro.dev/v5@v5.12.0/internal/website/docs/architecture/index.md (about)

     1  ---
     2  layout: default
     3  ---
     4  
     5  # Architecture Decision Records
     6  
     7  Documentation of architectural decisions made in Go Micro, following the ADR pattern.
     8  
     9  ## What are ADRs?
    10  
    11  Architecture Decision Records (ADRs) capture important architectural decisions along with their context and consequences. They help understand why certain design choices were made.
    12  
    13  ## Index
    14  
    15  ### Available
    16  - [ADR-001: Plugin Architecture](adr-001-plugin-architecture.md)
    17  - [ADR-004: mDNS as Default Registry](adr-004-mdns-default-registry.md)
    18  - [ADR-009: Progressive Configuration](adr-009-progressive-configuration.md)
    19  
    20  ### Planned
    21  
    22  **Core Design**
    23  - ADR-002: Interface-First Design
    24  - ADR-003: Default Implementations
    25  
    26  **Service Discovery**
    27  - ADR-005: Registry Plugin Scope
    28  
    29  **Communication**
    30  - ADR-006: HTTP as Default Transport
    31  - ADR-007: Content-Type Based Codecs
    32  
    33  **Configuration**
    34  - ADR-008: Environment Variable Support
    35  
    36  ## Status Values
    37  
    38  - **Proposed**: Under consideration
    39  - **Accepted**: Decision approved
    40  - **Deprecated**: No longer recommended
    41  - **Superseded**: Replaced by another ADR
    42  
    43  ## Contributing
    44  
    45  To propose a new ADR:
    46  
    47  1. Number it sequentially (check existing ADRs)
    48  2. Follow the structure of existing ADRs
    49  3. Include: Status, Context, Decision, Consequences, Alternatives
    50  4. Submit a PR for discussion
    51  5. Update status based on review
    52  
    53  ADRs are immutable once accepted. To change a decision, create a new ADR that supersedes the old one.