- Status: accepted
- Date: 2021-07-08
- Authors: @richardcase
- Deciders: @richardcase
Decisions that affect the development of flintlock that are not captured via a proposal need to be captured in some way. We need a method that is lightweight and easy to discover the decision that have been made. The record of decisions will help future contributors to the project to understand why something has been implemented or is done a certain way.
The project will use Architectural Decision Records (ADR) to record decisions that are made outside of a proposal.
A template has been created based on prior work:
- https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
- https://adr.github.io/madr/
When decisions are made that affect the entire project then a new ADR needs to be created. Likewise, if a decision has been superceded then we need to caputure this as a new ADR and mark the previous ADR as superceded. Maintainers and contributors will need to decide when an ADR is to be created.