Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
14 lines (13 loc) · 635 Bytes

CONTRIBUTING.md

File metadata and controls

14 lines (13 loc) · 635 Bytes
Raw

Contributing

  1. Build: swift build
  2. Test: swift test (set IPDATA_LIVE=1 to also run the live smoke tests against https://ipdata.info)
  3. Smoke-check the example manually: 
    clang -fobjc-arc -ISources/IPData/include Sources/IPData/*.m examples/quickstart.m \
  -framework Foundation -o /tmp/ipdata_objc_smoke && /tmp/ipdata_objc_smoke
  4. Keep the public API in Sources/IPData/include/IPDataClient.h in sync with docs/sdk-api-contract.md -- every other official SDK mirrors the same method surface.
  5. Open a PR; CI runs swift build + swift test on macOS.