Skip to content

ADR-NNNN: Short descriptive title ​

Status ​

Proposed

Context ​

What prompted this decision? Describe the problem, the forces at play, and any constraints. Link to related issues, discussions, or external references. A new contributor should be able to read this section and understand why a choice had to be made, without needing to know the outcome.

Decision ​

What was decided. State it plainly, in one or two sentences if possible. If the decision has scope limits ("applies only to X") or carve-outs, call them out here.

Consequences ​

What follows from this decision — both the positive and the negative. Include:

  • Benefits the decision unlocks.
  • Costs, trade-offs, or future work it creates.
  • Constraints it places on contributors (e.g., "new CLI commands must also do X").
  • Any compatibility implications (breaking change, deprecation window).

This section is where a future contributor reading the ADR learns what they are allowed to change and what they should not.

Licensed under Apache License 2.0