docs(decisions): ADR-020 adopt EARS syntax for normative requirements (#666) - #669
Draft
scottschreckengaust wants to merge 1 commit into
Draft
docs(decisions): ADR-020 adopt EARS syntax for normative requirements (#666)#669scottschreckengaust wants to merge 1 commit into
scottschreckengaust wants to merge 1 commit into
Conversation
…#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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 viamise //docs:sync(do not hand-edit).Notes for reviewers
ADR-018is claimed by in-flight PRs docs(decisions): ADR-018 propose central agent asset registry (#246) #548 and feat(carve S8): wire the orchestration arc into the stack and activate it #662, andADR-019by docs(decisions): ADR-019 unify agent tools behind an AgentCore Gateway (#641) #663.ADR-020is the first number colliding with nothing in-flight. If the queue shuffles before merge, this file may need renumbering (slug kept stable so only the prefix changes).proposed, flips toacceptedwhen this merges (perdocs/decisions/README.mdlifecycle).Local verification
mise //docs:build✓ ·mise //docs:syncstable (no mutation) ✓ ·mise //docs:link-checkexit 0 ✓ ·mise //docs:check(astro) 0 errors/0 warnings/0 hints ✓origin/main..HEAD) — no leaks. (The pre-push full-history sweep flags 4 pre-existingaws-account-idfindings on sibling branchfeat/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