Skip to content

docs: add public API compatibility checklist (#449) #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
El-swaggerito merged 1 commit into from
Jul 29, 2026
Merged

docs: add public API compatibility checklist (#449) #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,6 @@ compatibility.
import { PocketPay } from '@axionvera/pocketpay-sdk';
const sdk = new PocketPay({ network: 'testnet' });

==================================================
==================================================
## Public API Compatibility
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.
12 changes: 12 additions & 0 deletions docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# PocketPay SDK — Public API Compatibility Checklist

This checklist must be completed for any PR modifying poublicly exported functions, types, classes, or constants within the PocketPay SDK.

---

## 1. Exported Functions & Types Review

- [ ] *&Signature Stability:** Are function signatures, parameter orders, and return types preserved or
Strictly additive?
- [ ] *&Export Suficiency:** Are all new or
modified types/interfaces exported from the root `�w^Ĺ�̀�����ɽ�ɥ�ѕ�䤁ݥѡ��Ё�ɕ�ͥ�����ѕɹ����(��l�t����9��������ٕ�ѥ���訨�����܁������́�����ɴ�Ѽ����ѥ���M,�����������ѕɹ̀�������A�͍���͔���ȁ����̰�������͔���ȁ�չ�ѥ��̤�((���((���ȸ� ɕ������������م�Յѥ��((��l�t����9��� ɕ������ՅɅ�ѕ�訨���́ѡ�́����������х�������݅ɑ́�����ѥ������ݥѠ����ѥ����ͽ��յ����(��l�t������ɕ��ѥ����������訨�%�����ɕ��������������́չ�ٽ���������́ѡ������A$���ɭ����́����ɕ��ѕ��ݥѠ�������ȁ��ѕɹ�ѥٔ�(��l�t����5���ȁY��ͥ��� ���訨�%́ѡ�́�ɕ������������������������䁙���������ȁ���͕�ٕȁ����ȁٕ�ͥ���ɕ���͔�((���((���̸�5��Ʌѥ���9�ѕ̀����յ��хѥ��((��l�t����5��Ʌѥ���ե��訨�ɔ��ѕ�����ѕ�����Ʌѥ��������Սѥ��́�ɽ٥������ȁ��䁑��ɕ��ѕ���ȁ��ѕɕ��A$����ѕɹ��(��l�t����)M�����Q�����訨�ɔ������Չ����A$���������́�ձ�䁑��յ��ѕ��ݥѠ������ȁ)����������̰���Ʌ��ѕȁ��͍ɥ�ѥ��̰������ᅵ�����((���((���и�Q���̀��ᅵ���́Y�ɥ����ѥ��((��l�t����%�ѕ�Ʌѥ���Q����訨�ɔ�ѡ�ɔ�ѕ��ٕ́ɥ�她��ѡ�Ёѡ��9�ܽU���ѕ��A$�ݽɭ́�́�����ѕ�������ɕ����ѥ��M,�����յ�ѥ���͍���ɥ����(��l�t����ᅵ���̀������訨�ɔ�����������ᅵ���́����ѡ��ɕ�������ȁ��������́����ѕ��Ѽ�ɕ����Ёѡ��A$���������(
Expand Down