Skip to content

ADR-NNNN: <short title of the decision> ​

Context and Problem Statement ​

<Describe the context and the problem. Two to four sentences. A good test: a future contributor reading only this section should understand why a decision was needed, without having to read the rest.>

Decision Drivers ​

  • <force or constraint pushing the decision>
  • <force or constraint pushing the decision>
  • <…>

Considered Options ​

  • <Option A — one line>
  • <Option B — one line>
  • <Option C — one line>

Decision Outcome ​

Chosen option: "<Option X>", because <justification — reference the drivers above where possible>.

Consequences ​

  • Good: <positive consequence>
  • Good: <positive consequence>
  • Bad: <cost or tradeoff accepted>
  • Bad: <cost or tradeoff accepted>

Pros and Cons of the Options ​

Option A — <name> ​

<optional expanded description>

  • Good: <…>
  • Neutral: <…>
  • Bad: <…>

Option B — <name> ​

  • Good: <…>
  • Neutral: <…>
  • Bad: <…>

More Information ​

<Links to related ADRs, issues, commits, PRs, or external references. Leave the section out entirely if there is nothing to add.>

Released under the Apache License 2.0. Documentation for 1.43.0.