A2A/adrs/adr-template.md
Darrel e6c5699c55
docs: Added adr template and protojson adr (#1214)
Added ADR that captures decision to use ProtoJSON as the normative
reference for JSON serialization

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Luca Muscariello <muscariello@ieee.org>
2026-01-13 22:16:06 -05:00

1.8 KiB

ADR-[number]: [Title]

Status: [Proposed | Accepted | Deprecated | Superseded]

Date: YYYY-MM-DD

Decision Makers: [List of people involved in the decision]

Technical Story: [Optional: Link to related issue/story]

Context

[Describe the context and problem statement. What is the issue that we're seeing that is motivating this decision or change?]

Decision Drivers

  • [Driver 1: e.g., performance requirements]
  • [Driver 2: e.g., maintainability concerns]
  • [Driver 3: e.g., team expertise]
  • [Driver 4: e.g., cost considerations]

Considered Options

  • [Option 1]
  • [Option 2]
  • [Option 3]

Decision Outcome

Chosen option: "[Option X]"

[Describe why this option was selected. What are the expected positive outcomes?]

Consequences

Positive

  • [Positive consequence 1]
  • [Positive consequence 2]

Negative

  • [Negative consequence 1]
  • [Negative consequence 2]

Neutral

  • [Neutral consequence 1]

[Optional] Pros and Cons of the Options

[Option 1]

[Brief description of option 1]

Pros:

  • [Advantage 1]
  • [Advantage 2]

Cons:

  • [Disadvantage 1]
  • [Disadvantage 2]

[Option 2]

[Brief description of option 2]

Pros:

  • [Advantage 1]
  • [Advantage 2]
  • [Advantage 2]

Cons:

  • [Disadvantage 1]
  • [Disadvantage 2]

[Option 3]

[Brief description of option 3]

Pros:

  • [Advantage 1]
  • [Advantage 2]
  • [Advantage 2]

Cons:

  • [Disadvantage 1]
  • [Disadvantage 2]

Implementation

[Optional: Describe the implementation plan, timeline, and any specific technical details]

  • [Link to related ADR 1]
  • [Link to related ADR 2]

References

  • [Link to resource 1]
  • [Link to resource 2]
  • [Link to resource 3]

Notes

[Any additional notes, follow-up items, or context that doesn't fit elsewhere]