Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.26 KB
Raw

Contributing

Thanks for your interest in improving the Ipregistry Erlang client!

Reporting issues

Please open a GitHub issue with the OTP version, the library version, and a minimal reproduction. Never include your API key in an issue.

Development setup

Requires Erlang/OTP 27+ and rebar3. Without a local install, make docker-check runs the full check inside the official erlang:29 container.

make            # format check, compile, xref, dialyzer, eunit, common test
make fmt        # apply erlfmt formatting

The behavior tests (test/ipregistry_SUITE.erl) run against a local mock API server and need no network access or API key. The live system tests (test/ipregistry_system_SUITE.erl) consume API credits and only run when IPREGISTRY_API_KEY is set:

IPREGISTRY_API_KEY=your_key make system-tests

Pull requests

  • Keep the library dependency-free: it must build with Erlang/OTP alone.
  • Add or update tests for any behavior change; offline tests belong in the EUnit modules or ipregistry_SUITE.
  • Run make before pushing — CI enforces formatting, xref, dialyzer, and all offline tests.
  • Update CHANGELOG.md under the [Unreleased] section.