sigs.k8s.io/cluster-api-provider-aws@v1.5.5/docs/adr/0001-use-adrs-for-decisions.md (about)

     1  # 1. Use ADRs to record decisions
     2  
     3  * Status: proposed
     4  * Date: 2020-10-29
     5  * Authors: @richardcase
     6  * Deciders: [list of GitHub handles for those that made the decision]  <!-- mandatory -->
     7  
     8  ## Context
     9  
    10  Currently decisions that affect ongoing CAPA development are being made via:
    11  
    12  1. CAEP for larger or more impactful pieces of work
    13  2. Discussions on issue, PRs, in Slack or in the bi-weekly community call.
    14  
    15  The decisions made via 2) are not easily discoverable and may not be documented. The CAPA project needs a way to record these decisions so they are easily discoverable by the contributors when they are looking to understand why something is done a particular way.
    16  
    17  ## Decision
    18  
    19  The project will use [Architectural Decision Records (ADR)](https://adr.github.io/) to record decisions that are applicable across the project and that are not explicitly covered by a CAEP. Additionally, in the implementation of a CAEP decisions may still be made via discussions and so ADRs should be created in this instance as well.
    20  
    21  A [template](./0000-template.md) has been created based on prior work:
    22  
    23  * https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
    24  * https://adr.github.io/madr/
    25  
    26  ## Consequences
    27  
    28  When decisions are made that affect the entire project then these need to be recorded as an ADR. For decisions that are made as part of discussion on issues or PRs a new label could be added `needs-adr` (or something similar) so that its explicit. For decisions made on slack or via Zoom call someone will need to take an action to create the PR with the ADR. Maintainers and contributors will need to decide when a "decision" has been made and ensure an ADR is created.