[#901] General: Introduce architecture decision records (ADRs) for major changes - #922
Merged
Conversation
|
@broda-spendy Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
broda-spendy
force-pushed
the
fix/901-general-introduce-architecture-decision-records-adrs-for-major-changes
branch
2 times, most recently
from
July 27, 2026 10:01
61ea507 to
a245112
Compare
…forcement (Junirezz#901) Implements the ADR process for YieldVault RWA — Issue Junirezz#901. ## What was already in place - docs/architecture-decision-records/README.md (process docs) - docs/architecture-decision-records/template.md (blank template) - No actual ADR files; index table was empty; no CI enforcement ## What this PR adds ### 4 foundational ADRs | ADR | Title | |-----|-------| | ADR-001 | Use Prisma as the Database ORM | | ADR-002 | Write-Ahead Audit Log for Admin Configuration Changes | | ADR-003 | API Contract Schema Snapshots for Backward-Compatibility | | ADR-004 | Multi-Tenant Vault Isolation via Soroban Smart Contracts | Each ADR contains: Date, Status, Context, Decision, Rationale, Alternatives Considered (with pros/cons), Consequences, and Related Links. ### README.md index updated The index table now lists all 4 ADRs with links, dates, and statuses. ### CI enforcement script (backend/scripts/check-adrs.js) Validates all ADRs on every CI run: 1. Naming convention: ADR-NNN-<slug>.md (lowercase hyphens) 2. Unique ADR numbers (no duplicates) 3. Required front-matter fields: **Date:** and **Status:** 4. At least one level-2 (##) heading per file 5. Every ADR file is listed in the README.md index table Exits 0 on success, 1 with descriptive errors on any violation. ### package.json - adrs:check script added (standalone) - ci:governance extended: ...&& node scripts/check-adrs.js ## Test results - ADR lint: 4/4 ADRs pass all 5 checks ✅ - Backend test suite: 33 failed / 4 failed (identical to main, zero regressions) ✅ Closes Junirezz#901
broda-spendy
force-pushed
the
fix/901-general-introduce-architecture-decision-records-adrs-for-major-changes
branch
from
July 27, 2026 10:03
a245112 to
bd8aa4b
Compare
Junirezz
added a commit
that referenced
this pull request
Jul 29, 2026
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
2 participants
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.
Summary
Fully implements the ADR process for YieldVault RWA (Issue #901), including 4 foundational records documenting major decisions already in the codebase, a CI enforcement script, and the README index.
What was already in place
docs/architecture-decision-records/README.md— process documentationdocs/architecture-decision-records/template.md— blank templateWhat this PR adds
4 foundational ADRs
Each ADR contains: Date, Status, Context, Decision, Rationale, Alternatives Considered (with pros/cons), Consequences, and Related Links to the relevant code.
docs/architecture-decision-records/README.md— index updatedThe index table now lists all 4 ADRs with links, dates, and statuses.
backend/scripts/check-adrs.js(new)CI validation script with 5 enforced rules:
ADR-NNN-<slug>.md**Date:**and**Status:**backend/package.jsonadrs:checkstandalone scriptci:governanceextended:... && node scripts/check-adrs.jsCI check results
Backend test suite: 33 failed / 4 failed — identical to main (zero regressions).
Acceptance criteria
Closes #901