Skip to content

Appcircle Decision Records (ADR)

This page is the canonical index of Appcircle's architecture decisions. Each ADR is immutable once Accepted; updates happen via a new ADR that Supersedes the old one.


Status legend

  • Accepted – The decision is in effect.
  • 📝 Proposed – Under discussion, not final.
  • Superseded – Replaced by a newer ADR (linked).
  • 🚫 Rejected – Considered, not adopted.
  • 🧪 Deprecated – Being phased out.

Tip: Keep ADRs short, focused, and written for future readers.


ADR catalogue

Ordered by ADR number. Filenames are NNNN-title.md.


How to add a new ADR

  1. Pick the next number (zero-padded), e.g. 0002.
  2. Create the file under docs/adr/: docs/adr/0002-your-title.md
  3. Use this header in the ADR file:

# ADR-0002: Your Title

- **Status:** 📝 Proposed
- **Date:** YYYY-MM-DD
- **Owners:** @team/architecture

## Context
Why is this decision needed? Constraints, goals, assumptions.

## Decision
The choice made, stated clearly.

## Options considered
- Option A — pros / cons
- Option B — pros / cons

## Consequences
- Positive:
- Negative:
- Follow-ups / migrations:

## Links
- Related issues/PRs:
- Supersedes / Superseded by:
4. Add a line for your ADR to the ADR catalogue above (keep order by number). 5. Commit and open a PR. On acceptance, change Status to ✅ Accepted (or note supersession).


Conventions

-- One decision per ADR. If scope drifts, split it.

-- Stable links: never rename ADR files; create a new ADR to supersede.

-- Traceability: link issues/PRs and impacted components (e.g., Keycloak, Vault, Helm charts).