You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
1.3 KiB

  1. # ADR {ADR-NUMBER}: {TITLE}
  2. ## Changelog
  3. - {date}: {changelog}
  4. ## Context
  5. > 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.
  6. ## Decision
  7. > This section explains all of the details of the proposed solution, including implementation details.
  8. > It should also describe affects / corollary items that may need to be changed as a part of this.
  9. > If the proposed change will be large, please also indicate a way to do the change to maximize ease of review.
  10. > (e.g. the optimal split of things to do between separate PR's)
  11. ## Status
  12. > A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
  13. {Deprecated|Proposed|Accepted}
  14. ## Consequences
  15. > This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones.
  16. ### Positive
  17. ### Negative
  18. ### Neutral
  19. ## References
  20. > 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!
  21. - {reference link}