Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (21 loc) · 694 Bytes

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 694 Bytes
Raw

Contributing

Thanks for considering a contribution to ipdatainfo.

Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Tests

python -m unittest discover -s tests -t . -v

To include the live smoke test against https://ipdata.info (requires network):

IPDATA_LIVE=1 python -m unittest discover -s tests -t . -v

Pull requests

  • Keep changes scoped and add/update tests for behavior changes.
  • Match the method surface in docs/sdk-api-contract.md — this SDK must stay behaviorally identical to the other official ipdata.info SDKs.
  • Run the test suite before opening a PR.