Use ADRs

Status

Accepted

Context

Documentation is scattered or non-existent. We have some docs for the way things are, but not always for why they are that way. This can formalize the process of proposing architectural changes and leave a paper trail that is easy to follow.

Decision

Use simple text files to propose, review and accept architectural and other related processes in this repository. Leverage git to version our ADRS. Leverage github to review and accept proposals in a pr. Display the current versions on our docs site.

Consequences

Pros

  • More formalized architectural review process

  • Easy to find paper trail

  • Centralization on docs site

Cons

  • Adds red tape

  • Can get out of date if not updated or maintained - causing even more confusion