Skip to content

docs(decisions): ADR-020 adopt EARS syntax for normative requirements (#666) - #669

Merged
scottschreckengaust merged 1 commit into
mainfrom
worktree-docs+666-ears-requirements-syntax
Jul 28, 2026
Merged

scottschreckengaust merged 1 commit into
mainfrom
worktree-docs+666-ears-requirements-syntax

Conversation

@scottschreckengaust

Copy link
Copy Markdown
Contributor

Adopt EARS (Easy Approach to Requirements Syntax) as the required syntax for normative requirements in ADRs, per issue #666. Adds ADR-020 (status: proposed) and its regenerated Starlight mirror.

Area

  • docs — guides or design sources (docs/guides/, docs/design/)

Related

Changes

  • docs/decisions/ADR-020-ears-requirements-syntax.md — new ADR. Defines the five EARS patterns (ubiquitous, event-driven, state-driven, optional-feature, unwanted-behavior) and requires them for normative requirements. Dogfoods itself: the Decision section's normative requirements are written in EARS; explanatory prose (Context, Consequences) is intentionally out of scope.
  • docs/src/content/docs/decisions/Adr-020-ears-requirements-syntax.md — regenerated Starlight mirror via mise //docs:sync (do not hand-edit).

Notes for reviewers

Local verification

  • mise //docs:build ✓ · mise //docs:sync stable (no mutation) ✓ · mise //docs:link-check exit 0 ✓ · mise //docs:check (astro) 0 errors/0 warnings/0 hints ✓
  • gitleaks on my commit range (origin/main..HEAD) — no leaks. (The pre-push full-history sweep flags 4 pre-existing aws-account-id findings on sibling branch feat/agentcore-gateway-mcp, unrelated to this diff.)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

🤖 Generated with Claude Code

…#666)

Adopt EARS (Easy Approach to Requirements Syntax) as the required syntax
for normative requirements in ADRs. The ADR states its own Decision in
EARS to dogfood the standard; explanatory prose is intentionally out of
scope. Regenerates the Starlight decisions mirror via docs:sync.

Status: proposed (flips to accepted when this PR merges).

Note: ADR-018 (#548, #662) and ADR-019 (#663) are claimed by in-flight
PRs; 020 is the first free number. May need renumbering if the queue
shuffles before merge.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@scottschreckengaust
scottschreckengaust marked this pull request as ready for review July 28, 2026 20:04
@scottschreckengaust
scottschreckengaust requested review from a team as code owners July 28, 2026 20:04
@scottschreckengaust
scottschreckengaust added this pull request to the merge queue Jul 28, 2026
Merged via the queue into main with commit 4596b66 Jul 28, 2026
9 checks passed
@scottschreckengaust
scottschreckengaust deleted the worktree-docs+666-ears-requirements-syntax branch July 28, 2026 20:23
@scottschreckengaust scottschreckengaust added the v1 Version 1 label Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v1 Version 1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The ABCA ADR standard shall require EARS syntax for normative requirements

2 participants