Back to Sylius

[short title of solved problem and solution]

adr/_template.md

2.2.51.3 KB
Original Source

[short title of solved problem and solution]

  • Status: [proposed | rejected | accepted | deprecated | … | superseded by ADR-0005]
  • Date: [YYYY-MM-DD when the decision was last updated] <!-- optional -->

Context and Problem Statement

[Describe the context and problem statement, e.g., in free form using two to three sentences. You may want to articulate the problem in form of a question.]

Decision Drivers <!-- optional -->

  • [driver 1, e.g., a force, facing concern, …]
  • <!-- numbers of drivers can vary -->

Considered Options

[option 1]

[example | description | pointer to more information | …] <!-- optional -->

  • Good, because [argument a]
  • Bad, because [argument b]
  • <!-- numbers of pros and cons can vary -->

[option 2]

[example | description | pointer to more information | …] <!-- optional -->

  • Good, because [argument a]
  • Bad, because [argument b]
  • <!-- numbers of pros and cons can vary -->

Decision Outcome

Chosen option: "[option 1]", because [justification. e.g., only option, which meets k.o. criterion decision driver | which resolves force force | … | comes out best (see below)].

References <!-- optional -->

  • [Link type] [Link to ADR] <!-- example: Refined by [ADR-0005](0005-example.md) -->
  • <!-- numbers of links can vary -->