Architectural Decision Records (ADRs) - status-im/status-wiki GitHub Wiki

Architectural Decision Records (ADRs)

πŸ“‚ ADR Index

This is a list of documented ADRs in this wiki: πŸ“Œ View all our ADRs in the ADR Index

πŸ“œ What Are ADRs?

Architectural Decision Records (ADRs) document important technical and design decisions made in the Status ecosystem. These records provide a historical reference, ensuring that decisions are transparent, justified, and revisitable.

ADRs help:

  • πŸ“Œ Capture the context around key technical choices.
  • πŸ“– Explain the reasoning behind major architectural decisions.
  • πŸ”„ Enable future contributors to understand and challenge past decisions.
  • πŸ“‚ Maintain a structured history of the evolution of Status’s architecture.

πŸ“– How ADRs Work

Each ADR follows a consistent format to ensure clarity and ease of reference. A typical ADR includes:

1️⃣ Title – A concise description of the decision.
2️⃣ Status – Indicates whether the decision is proposed, accepted, rejected, superseded, or deprecated.
3️⃣ Context – Background information explaining why this decision was needed.
4️⃣ Decision – The chosen approach and justification.
5️⃣ Consequences – The expected impact of this decision, including trade-offs.

✍️ How to Propose a New ADR

To propose a new ADR:

  1. Check for existing ADRs - Ensure that a similar decision has not already been recorded.
  2. Follow the ADR template - Use the ADR Template to maintain consistency.
  3. Write the ADR - Clearly explain the problem, context, decision, and consequences.
  4. Submit for review - Share the ADR for discussion and approval.

πŸ”— Related Resources

πŸ’‘ ADRs help build a strong, transparent, and well-documented technical foundation for Status. Every decision matters, help us keep track of them! πŸš€