Skip to content

contrib: docs and examples for issues 293, 300, 281, 276 - #361

Merged
davedumto merged 1 commit into
Vellar-Wallet:dripsfrom
Olorunfemi20:contrib/issue-293-300-281-276-docs-and-guards
Aug 31, 2026
Merged

contrib: docs and examples for issues 293, 300, 281, 276#361
davedumto merged 1 commit into
Vellar-Wallet:dripsfrom
Olorunfemi20:contrib/issue-293-300-281-276-docs-and-guards

Conversation

@Olorunfemi20

Copy link
Copy Markdown

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.

  • contrib/examples/issue-293-policy-schema-migration-guide — a guide describing how to detect an outdated cached policy schema, a versioned migration helper patterned after the session store's storage-adapter approach (src/session.ts), and a test that runs the documented migration steps end to end against a fixture.
  • contrib/examples/issue-300-deprecation-warning-pattern — a reusable deprecation pattern (JSDoc @deprecated plus a one-time console.warn) for an SDK method superseded by a newer client, including the exact CHANGELOG.md entry shape a maintainer would add. payments.ts and payments-client.ts don'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.
  • contrib/examples/issue-281-release-process-guide — a stage-by-stage release process doc (versioning, changelog, build/verify, publish), noting what's automated vs. manual, linking to the actual .github/workflows/ci.yml, publish.yml, and verify-merged.yml. Written to be folded into CONTRIBUTING.md by a maintainer.
  • contrib/examples/issue-276-rpc-timeout-budget — a timeout-budget wrapper for the policy-deployment RPC calls (simulate, deployInstance, recordDeployment), mirroring policy-client.ts's request-helper shape, with a distinct typed PolicyDeployTimeoutError (kept separate from PolicyApiError since 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 — passes
  • npm test — 104 test files, 639 tests, all passing (includes the 24 new tests across the three code-bearing entries)
  • npm run build — passes

closes #293
closes #300
closes #281
closes #276

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
@drips-wave

drips-wave Bot commented Aug 30, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@vercel

vercel Bot commented Aug 30, 2026

Copy link
Copy Markdown

@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.

@davedumto
davedumto merged commit 4a4bccd into Vellar-Wallet:drips Aug 31, 2026
1 of 2 checks passed
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.

2 participants