contrib: docs and examples for issues 293, 300, 281, 276 - #361
Merged
davedumto merged 1 commit intoAug 31, 2026
Merged
Conversation
Adds four self-contained contrib/examples entries, each scoped to one assigned issue: - issue-293: a guide and fixture-backed test for detecting and migrating locally cached policy data across schema versions, following the same versioned-storage pattern used by the session store. - issue-300: a reusable deprecation pattern (JSDoc @deprecated plus a one-time console warning) for SDK methods superseded by a newer client, with the CHANGELOG entry shape a maintainer would add alongside it. - issue-281: a stage-by-stage release process guide (versioning, changelog, build/verify, publish) describing what's automated versus manual, with links to the actual CI/publish/verify-merged workflow files. - issue-276: a timeout-budget wrapper for the policy deployment RPC calls (simulate, deployInstance, recordDeployment), with a distinct typed PolicyDeployTimeoutError and tests verifying the timeout triggers per configured budget. closes Vellar-Wallet#293 closes Vellar-Wallet#300 closes Vellar-Wallet#281 closes Vellar-Wallet#276
|
@Olorunfemi20 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! 🚀 |
|
@Olorunfemi20 is attempting to deploy a commit to the david's projects Team on Vercel. A member of the Team first needs to authorize it. |
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.
Summary
Four contrib/examples entries, each scoped to one assigned issue. Per CONTRIBUTING.md and contrib/README.md, every change here is confined to contrib/examples/ — no files outside that folder are touched.
@deprecatedplus a one-timeconsole.warn) for an SDK method superseded by a newer client, including the exact CHANGELOG.md entry shape a maintainer would add.payments.tsandpayments-client.tsdon't currently have an actually-redundant method pair (payments.ts holds pure types/parsing that payments-client.ts's client builds on top of), so this documents the mechanism a maintainer can apply directly the moment a real deprecation is needed, rather than inventing a contrived one on a real export..github/workflows/ci.yml,publish.yml, andverify-merged.yml. Written to be folded into CONTRIBUTING.md by a maintainer.PolicyDeployTimeoutError(kept separate fromPolicyApiErrorsince a timeout means no server decision was ever received) and tests verifying the timeout fires per configured budget.Each folder has its own README (or, for #281, RELEASE_PROCESS.md) explaining the requirement, the pattern, how it maps onto the real source file it targets, and how to run it.
Test plan
npm run typecheck— passesnpm test— 104 test files, 639 tests, all passing (includes the 24 new tests across the three code-bearing entries)npm run build— passescloses #293
closes #300
closes #281
closes #276