Contributing

Pull requests

Title: Use Conventional Commits so history and release notes stay readable. Examples: feat(agent): add hook limit, fix(cli): handle EOF, chore(ci): bump Go version.
Checks: The CI workflow runs Go lint (golangci-lint), Go tests (with coverage on Linux), Rust fmt / clippy on phantom-cli + phantom-client (not the Tauri crate), Rust llvm-cov for those packages, full build including eBPF on Ubuntu, macOS build/test, and a Linux job that builds the agent with BPF artifacts (extended e2e is disabled until restored). PR checks validates the PR title.
Merge: Squash merge is recommended so the default commit message matches the PR title.

In GitHub Settings → Branches, for main / master consider:

Require a pull request before merging
Require status checks to pass before merging. Enable every job from the CI workflow (note matrix jobs appear per OS, e.g. Lint (ubuntu-latest)), plus Conventional PR title from PR checks
Optionally require branches to be up to date before merging

Exact job names appear in the Actions tab and may include matrix suffixes (e.g. OS); pick the checks that match your workflow run.

Linux Go coverage is uploaded as a workflow artifact (go-coverage). Optional: add a repository secret CODECOV_TOKEN to push Go and Rust reports to Codecov (flags go and rust).

Tag a version with v* (e.g. v0.2.0) to trigger the Release workflow. It runs a Preflight job (go test ./..., Rust tests for phantom-cli / phantom-client), then builds cross-compiled phantom-agent binaries and phantom-cli for Linux amd64, and creates a GitHub Release with those assets.

make proto — regenerate Go protobufs (needs protoc).
make desktop-install / make desktop-dev — Phantom Desktop (Tauri); make desktop-build for release binary (see src/desktop/README.md).
make test-e2e-* — currently no-op placeholders while test/e2e is empty. See docs/testing.md.