Skip to content

Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) for the AXON project.

What is an ADR?

An ADR captures an important architectural decision along with its context and consequences.

ADR Format

Each ADR follows this format:

# ADR {number}: {title}

## Status

{Proposed | Accepted | Deprecated | Superseded}

## Context

{Describe the context and problem statement}

## Decision

{Describe the decision that was made}

## Consequences

### Positive

- {Positive consequence 1}
- {Positive consequence 2}

### Negative

- {Negative consequence 1}
- {Negative consequence 2}

### Neutral

- {Neutral consequence 1}

ADR Index

ADR Title Status
0001 Rust as Core Language Accepted
0002 Cargo Workspace Layout Accepted
0003 Apache-2.0 License Accepted

Creating New ADRs

  1. Create a new file: docs/adr/{number}-{title-slug}.md
  2. Use the template above
  3. Submit PR for review
  4. Update this index after approval

References