Skip to main content

adr-template

ADR {ADR-NUMBER}: {TITLE}

Changelog​

  • {date}: {changelog}

Status​

{DRAFT | PROPOSED} Not Implemented

Please have a look at the PROCESS page. Use DRAFT if the ADR is in a draft stage (draft PR) or PROPOSED if it's in review.

Abstract​

"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the ADR. A short (~200 word) description of the issue being addressed.

Context​

This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution. The language in this section is value-neutral. It is simply describing facts.

Decision​

This section explains all of the details of the proposed solution, including implementation details. It should also describe affects / corollary items that may need to be changed as a part of this. If the proposed change will be large, please also indicate a way to do the change to maximize ease of review. (e.g. the optimal split of things to do between separate PR's)

Consequences​

This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones.

Positive​

{positive consequences}

Negative​

{negative consequences}

Neutral​

{neutral consequences}

References​

Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!

  • {reference link}