Skip to content

Architecture decisions

This section publishes the package's Architecture Decision Records (ADRs) — short documents that capture each load-bearing design choice, the alternatives considered, and the trade-offs.

ADRs are the answer to "why is it built this way?" Many of them are surprising at first glance; reading the relevant ADR before proposing a change usually saves a round-trip.

Index

When a new ADR gets written

The maintainers add an ADR when a decision meets all three of:

  1. Hard to reverse — the cost of changing your mind later is meaningful.
  2. Surprising without context — a future reader will wonder "why did they do it this way?"
  3. The result of a real trade-off — there were genuine alternatives and one was picked for specific reasons.

If you're proposing a change that conflicts with an existing ADR, open an issue referencing the ADR number and outlining the new context that justifies revisiting it. ADRs are amended (with a "Superseded by ADR-XXXX" header) rather than rewritten in place.

Released under the MIT License.