Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
97 lines (64 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

97 lines (64 loc) · 1.98 KB
Raw

Contributing to AltSendme

Thank you for your interest in contributing. This guide covers local setup and how to submit changes.

Development setup

Prerequisites: Rust 1.91+, Node.js 20+, pnpm 10+

git clone https://github.com/tonyantony300/alt-sendme.git
cd alt-sendme
pnpm install

Desktop

pnpm tauri dev

Production build (skips installer/bundle packaging):

pnpm tauri build --no-bundle

Web app setup

Use the web target to run the app in a browser during development.

Start the web dev server:

pnpm build:wasm   
pnpm dev:web

Open http://localhost:3000/.

Production web build:

pnpm build:web
pnpm preview:web

Android

pnpm android:dev

Project layout

Path Purpose
frontend/ React UI (Tauri + web targets)
src-tauri/ Tauri desktop/Android shell
engine/ Rust P2P transfer engine
www/ Public Next.js site (planned)

Testing

To exercise transfers on a single machine, install the Sendme CLI and share files locally — traffic stays on your device.

Engine E2E tests:

cargo test --manifest-path engine/Cargo.toml

Pull requests

  1. Search existing issues before opening a new one.
  2. For bugs, use the bug report template.
  3. Run checks before opening a PR:
pnpm lint
pnpm format
  1. Fill out the pull request template.

Lockfiles: Do not commit lockfile-only changes. CI rejects PRs that modify pnpm-lock.yaml or Cargo.lock without a corresponding manifest change.

git checkout origin/main -- pnpm-lock.yaml src-tauri/Cargo.lock engine/Cargo.lock

Getting help

Please be respectful and considerate in all project spaces.