Architecture Decisions

[jamie-lynch]

Architecture Decisions Records are files where we can document the decisions we make around any form of structure, architecture or approach. By documenting them in this way, we can preserve the thought process behind all of the decisions whilst also laying out formally the preferences for all developers working on the library.

The docs/architecture-decision-records directory contains the records for @guardian/cdk.

If you want to start a conversation around an existing or new ADR then you can either raise a PR following the ADR template or start a new discussion.

When starting discussions about ADRs, the following things will help to keep the discussion clear:

• The following icons can be used in combination to denote the proposed action of a discussion.

  🆕 - A new ADR is being proposed
  ✏️ - An edit to an existing ADR is being proposed

  ✅ - The new or updated ADR has been agreed and merged
  ❌ - The discussion has been resolved with no new ADRs or updates to existing ADRs required

• Keep the original comment updated with any links to PRs

• Include a link to the ADR to be changed in the original comment