github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/adr/0001-record-architecture-decisions.md (about)

     1  # 1. Record architecture decisions
     2  
     3  Date: 2022-03-01
     4  
     5  ## Status
     6  
     7  Accepted
     8  
     9  ## Context
    10  
    11  > NOTE:
    12  >
    13  > This file was automatically created when we used [adr-tools](https://github.com/npryce/adr-tools) to initialize the document log in the repo. ADRs on ADRs are a little silly, but it does give a lightweight way to direct the reader over to our contributor guide that has a lot more information.
    14  
    15  We need to record the architectural decisions made on this project.
    16  
    17  ## Decision
    18  
    19  We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions), with a couple of small tweaks. See the [Documentation section in the Contributor guide](../CONTRIBUTING.md#documentation) for full details.
    20  
    21  ## Consequences
    22  
    23  See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).