github.com/fibonacci-chain/fbc@v0.0.0-20231124064014-c7636198c1e9/libs/iavl/docs/architecture/adr-template.md (about)

     1  # ADR {ADR-NUMBER}: {TITLE}
     2  
     3  ## Changelog
     4  
     5  - {date}: {changelog}
     6  
     7  ## Status
     8  
     9  > A decision may be "proposed" if the project stakeholders haven't agreed with it yet, or "accepted"
    10  > once it is agreed. If a later ADR changes or reverses a decision, it may be marked as "deprecated"
    11  > or "superseded" with a reference to its replacement.
    12  > {Deprecated|Proposed|Accepted}
    13  
    14  ## Context
    15  
    16  > This section describes the forces at play, including technological, political, social, and project
    17  > local. These forces are probably in tension, and should be called out as such. The language in this
    18  > section is value-neutral. It is simply describing facts.
    19  > {context body}
    20  
    21  ## Decision
    22  
    23  > This section describes our response to these forces. It is stated in full sentences, with active
    24  > voice. "We will ...".
    25  > {decision body}
    26  
    27  ## Consequences
    28  
    29  > This section describes the resulting context, after applying the decision. All consequences should
    30  > be listed here, not just the "positive" ones. A particular decision may have positive, negative,
    31  > and neutral consequences, but all of them affect the team and project in the future.
    32  
    33  ### Positive
    34  
    35  {positive consequences}
    36  
    37  ### Negative
    38  
    39  {negative consequences}
    40  
    41  ### Neutral
    42  
    43  {neutral consequences}
    44  
    45  ## References
    46  
    47  - {reference link}