github.com/Tri-stone/burrow@v0.25.0/docs/ADRs/adr-X_template.md (about)

     1  ---
     2  adr: <to be assigned>
     3  title: <ADR title>
     4  author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
     5  discussions-to: <URL>
     6  status: Draft
     7  type: <Standards Track (Accounts and State, Consensus, Crypto, EVM, Gateway)  | Informational | Meta>
     8  category (*only required for Standard Track): <Accounts and State | Consensus | Crypto | EVM | Gateway>
     9  created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
    10  requires (*optional): <ADR number(s)>
    11  replaces (*optional): <ADR number(s)>
    12  ---
    13  
    14  <!--You can leave these HTML comments in your merged ADR and delete the visible duplicate text guides, they will not appear and may be helpful to refer to if you edit it again. This is the suggested template for new ADRs. Note that an ADR number will be assigned by an editor. When opening a pull request to submit your ADR, please use an abbreviated title in the filename, `adr-draft_title_abbrev.md`. The title should be 44 characters or less.-->
    15  This is the suggested template for new ADRs.
    16  
    17  Note that an ADR number will be assigned by an editor. When opening a pull request to submit your ADR, please use an abbreviated title in the filename, `adr-draft_title_abbrev.md`.
    18  
    19  The title should be 44 characters or less.
    20  
    21  ## Simple Summary
    22  <!--"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the ADR.-->
    23  If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the ADR.
    24  
    25  ## Abstract
    26  <!--A short (~200 word) description of the technical issue being addressed.-->
    27  A short (~200 word) description of the technical issue being addressed.
    28  
    29  ## Motivation
    30  <!--The motivation is critical It should clearly explain why the existing protocol is inadequate to address the problem that the ADR solves. ADR submissions without sufficient motivation may be rejected outright.-->
    31  The motivation is critical for ADRs. It should clearly explain why the existing protocol is inadequate to address the problem that the ADR solves. ADR submissions without sufficient motivation may be rejected outright.
    32  
    33  ## Specification
    34  <!--The technical specification should describe the syntax and semantics of any new feature.-->
    35  The technical specification should describe the syntax and semantics of any new feature.
    36  
    37  ## Rationale
    38  <!--The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.-->
    39  The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.-->
    40  
    41  ## Backwards Compatibility
    42  <!--All ADRs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The ADR must explain how the author proposes to deal with these incompatibilities. ADR submissions without a sufficient backwards compatibility treatise may be rejected outright.-->
    43  All ADRs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The ADR must explain how the author proposes to deal with these incompatibilities. ADR submissions without a sufficient backwards compatibility treatise may be rejected outright.
    44  
    45  ## Test Cases
    46  <!--Test cases for an implementation are mandatory for ADRs that are affecting consensus changes. Other ADRs can choose to include links to test cases if applicable.-->
    47  Test cases for an implementation are mandatory for ADRs that are affecting consensus changes. Other ADRs can choose to include links to test cases if applicable.