Skip to content
WireTap

How to contribute

After this page you can get a working dev environment. This page summarizes CONTRIBUTING.md in the repo root — the repo file is authoritative.

Licensing

Section titled “Licensing”

WireTap is a proprietary product; the repository is not open to outside contributions. The one open component is the client SDK (packages/sdk/), which is MIT-licensed so integrators can read exactly what runs in their app. No GPL/AGPL dependencies anywhere in the shipped code.

Dev environment

Section titled “Dev environment”
Terminal window
pnpm install                                          # TS workspaces
cargo build                                           # Rust ingester
docker compose -f infra/docker-compose.yml up -d clickhouse
pnpm test && cargo test                               # unit + integration

The full local demo (localnet, demo program, ingester, mock bot, MCP):

Terminal window
pnpm demo

Ground rules

Section titled “Ground rules”
  • One logical change per PR; include tests.
  • Conventional-commit prefixes (feat:, fix:, docs: …).
  • Shared types, fingerprinting, and score math live in packages/shared — change them there, never fork copies. The website, API, bot and this documentation all import the same functions.
  • Methodology changes (bot heuristic, score formula, fingerprint recipe) bump the version and update the methodology page in the same PR.

Working on these docs

Section titled “Working on these docs”
Terminal window
pnpm --filter docs dev

Docs live in apps/docs/src/content/docs/. House style: every page opens with what the reader can do after it; every feature page has a copy-paste path to a working result; anything mocked pre-launch says so on the page.