Development

Development

Canonical guide: CONTRIBUTING.md. This page is the short path.

Prerequisites

Tool	Version	Why
Node.js	22.x+	What CI runs
Rust	stable, edition 2021	clippy + rustfmt required
cargo-llvm-cov	latest	Rust LCOV for coverage floors
actionlint	latest	Only local gate that reads release.yml before a tag
Git	maintained	Runtime, not just VCS
gh	optional	GitHub panel only

Platform:

• macOS: Xcode Command Line Tools. Universal release builds need both Darwin targets.
• Windows: MSVC build tools + WebView2.
• Linux (Debian/Ubuntu): libwebkit2gtk-4.1-dev, libgtk-3-dev, libssl-dev, libayatana-appindicator3-dev, librsvg2-dev, and friends — see CONTRIBUTING.md.

rustup component add clippy rustfmt llvm-tools-preview
cargo install cargo-llvm-cov --locked

Clone and run

git clone https://github.com/bharathvbcr/GitPulse.git
cd GitPulse
npm install
git config core.hooksPath .githooks
npm run tauri dev

The pre-push hook refuses a release tag that would publish the wrong tree. release.yml builds whatever commit the v* tag points at; only the machine holding both the tag and the work can know which commit you meant. Deliberate re-release of an older commit: git push --no-verify.

Vite picks a free port from 5173 (then 5174–5193). Pin with GITPULSE_DEV_PORT.

The gate

npm run ci:local

If that is green, .github/workflows/ci.yml and coverage.yml will be green on macOS, Linux, and Windows. Run it before opening a PR.

While iterating:

Command	Scope
npm test	Vitest
npx vitest run src/lib/graph	One directory
cargo test --manifest-path src-tauri/Cargo.toml	Rust suite
npm run check	svelte-check + tsc
npm run check:ipc	Rust cmd_* registry ↔ frontend invoke()
npm run check:types	serde structs ↔ TypeScript interfaces
npm run check:release	Version manifests agree
npm run mcp:install	Put this tree's gitpulse-mcp on PATH
npm run mcp:doctor	PATH binary matches this tree (not in ci:local)

Every bug fix ships with a test that fails against the unfixed code.

Pull requests

1. Branch from main.
2. One coherent concern.
3. npm run ci:local green.
4. Conventional Commits (feat:, fix:, docs:, test:, chore:, perf:).
5. Fill in the PR template.

Security issues: do not file a public issue. See Security.

Recognition

GitPulse follows All Contributors. Comment @all-contributors please add @username for code, doc on any issue or PR.