“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.
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.
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)