githubEdit

ADR-NNNN: Title

Status

Proposed | Accepted | Deprecated | Superseded

Date

YYYY-MM-DD

Context

What is the issue that we're seeing that is motivating this decision or change?

Describe:

  • The current situation

  • The problem we're trying to solve

  • Any constraints or requirements

  • Relevant background information

Decision

What is the change that we're proposing and/or doing?

Be specific about:

  • What we will do

  • What we will NOT do

  • Key implementation details

Consequences

What becomes easier or more difficult to do because of this change?

Positive

  • Benefit 1

  • Benefit 2

Negative

  • Drawback 1

  • Drawback 2

Neutral

  • Side effect 1

Alternatives Considered

What other options were considered?

Alternative 1: [Name]

Description of the alternative.

Pros:

  • Pro 1

Cons:

  • Con 1

Why rejected: Reason for not choosing this option.

Alternative 2: [Name]

...

References

  • Link to relevant documentation

  • Link to related issues or PRs

  • Link to external resources

Last updated

Was this helpful?