Skip to content

Commit b028a8e

Browse files
committed
docs: add public API compatibility checklist (#449)
1 parent 8c7b314 commit b028a8e

2 files changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,6 @@ compatibility.
198198
import { PocketPay } from '@axionvera/pocketpay-sdk';
199199
const sdk = new PocketPay({ network: 'testnet' });
200200

201-
==================================================
201+
==================================================
202+
## Public API Compatibility
203+
Before submitting changes to exported functions or types, review the [Public API Compatibility Checklist](docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md) to ensure backwards compatibility and proper migration guidance.

docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# PocketPay SDK �� Public API Compatibility Checklist
2+
3+
This checklist must be completed for any PR modifying poublicly exported functions, types, classes, or constants within the PocketPay SDK.
4+
5+
---
6+
7+
## 1. Exported Functions & Types Review
8+
9+
- [ ] *&Signature Stability:** Are function signatures, parameter orders, and return types preserved or
10+
Strictly additive?
11+
- [ ] *&Export Suficiency:** Are all new or
12+
modified types/interfaces exported from the root `^贏敊€€�謠刓賽��曹�搘恁調�腆�穸�塾�捺�(�l€€貝9旦�蝴�塾末嘐閮����謗奷��褕�捊�嵽迕旦�M,旦��旄嘐€��敦����栫�怜����悒蝴怳�((斐�((�€� �旦�����敕末�((�l€€�9螂� �旦���塾�閮���恁甘�����旦�斥��兼�蔥�悒悼栵由�生悒��芺腴桮泆(�l€€���悒螂���祈豕�%���郊�����甘�棌����甘���A$����賽��由�����伄矛(�l€€貝5褓穸螂� 燮豕�%�恁甘��旦����控���������忝��奼末���((斐�((�€抶�5��悒螂�9諸€��桮�悒螂((�l€€貝5��悒螂�掍�閮���懇腴��等末�旦迕尥末嘐刓晱�����賽������A$�伄泆(�l€€貝)M�€�Q斲��閮���掠�悼�A$��謗旦捈�梇曹��桮��搘����)��蔥�塾怜�民悒蝴怜����聒�泆((斐�((�€邽捈€��聒��Y��末�((�l€€貝%塾��悒螂捈閮����捈�憟���恁�9磊���A$褕們�������生悒�M,�蝴邯聒悒螂��犮翩(�l€€��聒���諒閮���掠���螫������絳�謠�桷���捊����A$����(

0 commit comments

Comments
 (0)