CONTRIBUTING.md

Contributing to Hindsight

Thanks for your interest in contributing!

Platform notes

Hindsight is currently tested on macOS only. Windows and Linux builds have not been verified yet.

Prerequisites

• Node.js 20+
• pnpm 9+
• Rust 1.75+

Linux only (Ubuntu/Debian, may be required):

sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev \
  libayatana-appindicator3-dev librsvg2-dev patchelf

Development setup

git clone https://github.com/deadbeef101010/hindsight.git
cd hindsight
pnpm install
pnpm tauri dev

Note: If UI changes are not picked up, run:

pnpm build && pnpm tauri dev

Project structure

crates/        # Core + providers + cache (Rust)
src-tauri/     # Tauri shell
ui/            # React frontend

Tests (optional)

cargo test

Pull requests

• Keep PRs focused and small.
• Include tests or update docs if needed.
• Open a PR from your fork/branch.

Reporting issues

Please include:

• OS and version
• Steps to reproduce
• Expected vs actual behavior
• Relevant logs or screenshots

License

By contributing, you agree that your contributions will be licensed under the MIT License.