Skip to content

README.md

Latest commit

 

History

History
38 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.46 KB
Raw

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records (ADRs) for HyperRender - documents that capture important architectural decisions along with their context and consequences.

What is an ADR?

An Architecture Decision Record (ADR) is a document that captures a significant architectural decision made along with its context and consequences.

Format

Each ADR follows this structure:

  • Title: Short noun phrase
  • Status: Proposed, Accepted, Deprecated, Superseded
  • Context: The issue motivating this decision
  • Decision: The change we're proposing or have agreed to
  • Consequences: The impacts of this decision (positive and negative)

Index

ADR Title Status
0001 Unified Document Tree (UDT) Model Accepted
0002 Single RenderObject Architecture Accepted
0003 CSS Float Layout Support Accepted
0004 CJK Line-Breaking (Kinsoku Shori) Accepted
0005 InlineSpan Over Widget Tree Accepted

Creating a New ADR

  1. Copy template.md to NNNN-title-with-dashes.md
  2. Fill in the sections
  3. Submit for review
  4. Update this index

References