Skip to content

Adopt date-prefixed ADR filenames#1835

Merged
kmcginnes merged 1 commit into
aws:mainfrom
kmcginnes:adr-naming-convention
Jun 16, 2026
Merged

Adopt date-prefixed ADR filenames#1835
kmcginnes merged 1 commit into
aws:mainfrom
kmcginnes:adr-naming-convention

Conversation

@kmcginnes

@kmcginnes kmcginnes commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Description

Establishes the ADR file-naming convention for the repo: YYYYMMDD-kebab-title.md, where the date is when the decision was accepted.

The previous example in docs/agents/domain.md implied sequential 0001-… numbering. Sequential IDs force a renumber whenever two branches each add an ADR from their own branch point — the second to merge collides on the same number. A date prefix stays sortable chronologically while sidestepping that churn. ADRs are referred to by their slug (e.g. event-sourced-orders).

Docs-only change to docs/agents/domain.md — updates the file-structure example and the reference style. No ADR files are added here; this just sets the naming standard so feature branches can follow it.

Validation

  • Docs-only; pnpm checks (format) passes.

Related Issues

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I have verified pnpm checks passes with no errors.
  • I have verified pnpm test passes with no failures.
  • I have covered new added functionality with unit tests if necessary.
  • I have updated documentation if necessary.

Name ADRs YYYYMMDD-kebab-title.md instead of a sequential 0001-style number.
The date prefix stays sortable while avoiding the renumbering churn two
branches hit when each adds an ADR from its own branch point. Refer to ADRs by
their slug.
@kmcginnes kmcginnes marked this pull request as ready for review June 16, 2026 20:55
@kmcginnes kmcginnes merged commit 4f2d24a into aws:main Jun 16, 2026
3 checks passed
@kmcginnes kmcginnes deleted the adr-naming-convention branch June 16, 2026 20:56
kmcginnes added a commit that referenced this pull request Jun 16, 2026
* Add ADRs for cross-tab persistence reconciliation strategy

Record the two architectural decisions governing the fix for #1820:
- IndexedDB (via localForage), not localStorage, for client-side
  persistence — Session and Schema payloads exceed localStorage's
  ~5MB limit, a constraint invisible in the code.
- Per-key diff-merge reconciliation at the storage layer, scoped to
  durability only; same-entry conflicts and live cross-tab freshness
  are explicitly deferred.

ADRs use the date-prefixed naming convention (#1835) and reference
each other by slug.

* Add core rule against hard-wrapping Markdown prose
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant