Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (51 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

73 lines (51 loc) · 1.4 KB
Raw

Contributing

Thanks for improving Human Mode. Keep changes small, testable, and honest about platform limits.

Development Setup

Prerequisites:

  • Node.js 20 or newer.
  • Rust stable.
  • Tauri v2 prerequisites for your platform.

Install dependencies:

npm ci

Run the web UI:

npm run dev

Run the desktop app:

npm run tauri dev

Checks

Run these before opening a pull request:

npm run typecheck
npm run build
cd src-tauri
cargo fmt --check
cargo test
cargo clippy --all-targets -- -D warnings

Code Style

  • Keep React components focused and small.
  • Put reusable app rules in src/domain.
  • Put Tauri command wrappers in src/tauri.
  • Keep native scanning logic in src-tauri/src/scanners.
  • Do not add new permissions without documenting why.
  • Do not collect prompt text, chat content, file content, cookies, or tokens.

Pull Requests

Good pull requests:

  • Fix one problem or add one coherent feature.
  • Include a short explanation of user-visible behavior.
  • Include verification steps.
  • Update documentation when detection, permissions, or privacy behavior changes.

Avoid broad refactors mixed with product changes.

Detection Rules

New watched targets should include:

  • Name and category.
  • App bundle or executable names where relevant.
  • CLI command names where relevant.
  • Domains where relevant.
  • Notes about false positives or unsupported platforms.