Dear SDK developers
Published in
2 min readApr 15, 2018
Part our job is to integrate 3rd services via SDKs. If it’s a good one, then lucky for us that it boosts us a lot in productivity . If it’s a bad one, then prepare ourselves for nightmare with integrating and bug tracing.
I’ve seen legacy SDKs with lots of compiler warnings that haven’t been updated for a while. I’ve seen, SDK that pulls in another 34 other dependencies, SDKs with no change log and documentation at all, SDKs that breaks other SDKs because of wrong assumption, …
- Please don’t do swizzling. Give us instructions on where to call your APIs instead of doing unnecessary swizzling. You’re making it for developers to use, and they know how to write code. Most of the time, you don’t know how to do swizzling right ⚠️
- Please don’t use configuration file. If possible, please consider configuration via pure code, instead of the plist file that is more exposable in the app bundle.
- Please don’t make assumption about the app. Your assumptions about the app the SDK is going to be integrated are not always correct. Every app has its own use case and view hierarchy.
- Please provide proper releases. Tag and make releases for new changes in the SDK. If there are major changes, there should be migration guide and affect of that to older apps. Also, please write proper change logs, either in release notes or change…