Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (32 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.28 KB
Raw

Contributing to VShell

Thanks for helping improve VShell.

Development Setup

Install Bun, Rust, and the Tauri 2 system dependencies for your operating system.

bun install
bun run tauri dev

The browser-only UI can be started with:

bun run dev

Native features such as terminals, SFTP, encrypted storage, tray behavior, startup registration, dialogs, and updates require the Tauri runtime.

Checks

Run these before opening a pull request:

bun audit
npm audit --audit-level=high
bun run test
bun run build
cargo test --manifest-path src-tauri/Cargo.toml
cargo clippy --manifest-path src-tauri/Cargo.toml --all-targets -- -D warnings
cargo audit --file src-tauri/Cargo.lock

Pull Requests

  • Keep changes focused.
  • Include tests for behavior changes when practical.
  • Update README.md, docs/RELEASE.md, or docs/SECURITY_AUDIT.md when setup, release, update, or security behavior changes.
  • Do not commit generated build output from dist/, src-tauri/target/, or installer bundles.
  • Do not include credentials, private hostnames, private keys, backup files, or real server screenshots in issues or pull requests.

Security Issues

Follow SECURITY.md for vulnerability reports. Do not post exploit details in public issues.