diff --git a/README.md b/README.md index 8abe13e..24e3ab7 100644 --- a/README.md +++ b/README.md @@ -198,4 +198,6 @@ compatibility. import { PocketPay } from '@axionvera/pocketpay-sdk'; const sdk = new PocketPay({ network: 'testnet' }); -================================================== \ No newline at end of file +================================================== +## 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. diff --git a/docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md b/docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md new file mode 100644 index 0000000..c35d0de --- /dev/null +++ b/docs/PUBLIC_API_COMPATIBILITY_CHECKLIST.md @@ -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$‘…Ή•Μό( \ No newline at end of file