Skip to content

docs: add dependency review guide and link from README#227

Merged
El-swaggerito merged 1 commit into
Axionvera:mainfrom
eleven-smg:docs/dependency-review-133
Jul 23, 2026
Merged

docs: add dependency review guide and link from README#227
El-swaggerito merged 1 commit into
Axionvera:mainfrom
eleven-smg:docs/dependency-review-133

Conversation

@eleven-smg

Copy link
Copy Markdown
Contributor

What

Adds docs/dependency-review.md, a dependency review standard for the PocketPay SDK, and links it from the README documentation list.

The guide covers:

  • Guiding principles for keeping the dependency tree small and auditable
  • The SDK's current runtime and development dependencies and their purpose
  • Criteria for adding a dependency (purpose, runtime vs development, maintenance status, security risk, size, license, alternatives)
  • Criteria for updating a dependency (changelog review, semver, security-first, one update per PR, local verification, lockfile)
  • Guidance on removing dependencies
  • A review checklist for any dependency change

Why

Dependency changes can introduce security, bundle-size, and compatibility risks. A written standard gives contributors a consistent process and supports future security reviews, as requested in the issue.

Notes

Documentation only - no source or dependency changes. README updated to link the new guide.

Closes #133

@El-swaggerito
El-swaggerito merged commit 9e50d97 into Axionvera:main Jul 23, 2026
1 check 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.

Add SDK dependency risk review document

2 participants