Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (23 loc) · 1017 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1017 Bytes
Raw

Contributing

Thanks for your interest in improving the PostHog Rust SDK.

Prerequisites

  • Rust 1.78.0 or newer (see Cargo.toml)

Development commands

From the repository root:

cargo build --verbose
cargo test --verbose
cargo test --verbose --features e2e-test --no-default-features
cargo fmt -- --check
cargo clippy -- -D warnings
scripts/check-public-api.sh

check-public-api.sh compares the public API in your working tree with the checked-in api/public-api.txt snapshot. If an API change is intentional, run scripts/check-public-api.sh --update and review the snapshot diff. It requires:

cargo install cargo-public-api --version 0.52.0 --locked
rustup toolchain install nightly-2026-06-12 --profile minimal

Running examples

See examples/README.md for the available example programs and the environment variables they use.

Pull requests

Please make sure the relevant build, test, formatting, and clippy checks pass before opening a PR.