github.com/fibonacci-chain/fbc@v0.0.0-20231124064014-c7636198c1e9/libs/cosmos-sdk/docs/architecture/README.md (about)

     1  ---
     2  order: false
     3  parent:
     4    order: false
     5  ---
     6  
     7  # Architecture Decision Records (ADR)
     8  
     9  This is a location to record all high-level architecture decisions in the Cosmos-SDK.
    10  
    11  You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t).
    12  
    13  An ADR should provide:
    14  
    15  - Context on the relevant goals and the current state
    16  - Proposed changes to achieve the goals
    17  - Summary of pros and cons
    18  - References
    19  - Changelog
    20  
    21  Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and
    22  justification for a change in architecture, or for the architecture of something
    23  new. The spec is much more compressed and streamlined summary of everything as
    24  it stands today.
    25  
    26  If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.
    27  
    28  Note the context/background should be written in the present tense.
    29  
    30  Please add a entry below in your Pull Request for an ADR.
    31  
    32  ## ADR Table of Contents
    33  
    34  - [ADR 002: SDK Documentation Structure](./adr-002-docs-structure.md)
    35  - [ADR 003: Dynamic Capability Store](./adr-003-dynamic-capability-store.md)
    36  - [ADR 004: Split Denomination Keys](./adr-004-split-denomination-keys.md)
    37  - [ADR 006: Secret Store Replacement](./adr-006-secret-store-replacement.md)
    38  - [ADR 009: Evidence Module](./adr-009-evidence-module.md)
    39  - [ADR 010: Modular AnteHandler](./adr-010-modular-antehandler.md)
    40  - [ADR 011: Generalize Genesis Accounts](./adr-011-generalize-genesis-accounts.md)
    41  - [ADR 012: State Accessors](./adr-012-state-accessors.md)
    42  - [ADR 015: IBC Packet Receiver](./adr-015-ibc-packet-receiver.md)
    43  - [ADR 016: Validator Consensus Key Rotation](./adr-016-validator-consensus-key-rotation.md)
    44  - [ADR 017: Historical Header Module](./adr-017-historical-header-module.md)