git.iko.soy/vibebox
on main help sign in
vibebox/CONTRIBUTING.md
44 lines 1.3 kB history raw
1# Contributing to Vibebox
3Thanks for your interest in contributing! This guide keeps PRs small, reviewable, and consistent with the project’s
4development workflow.
6**Prerequisites**
8- macOS on Apple Silicon (required for the virtualization backend)
9- Rust `1.91.1` or newer (see `Cargo.toml`)
11**Getting Started**
131. Fork the repo and create a feature branch.
142. Build once to validate your toolchain:
16```bash
17cargo build --locked
18```
20**Development Commands**
22- Format: `cargo fmt --all -- --check`
23- Lint: `cargo clippy --all-targets --all-features -- -D warnings`
24- Test: `cargo test --locked`
25- Build: `cargo build --locked`
27**Submitting Changes**
29- Keep changes focused and scoped to one problem.
30- Update or add tests when behavior changes.
31- If you change user-facing behavior, update docs or help text.
32- Avoid adding heavy dependencies without a clear reason.
34**Reporting Issues**
35Please include:
37- macOS version and hardware (Apple Silicon model)
38- Vibebox version (`vibebox --version`)
39- Steps to reproduce
40- Logs from `.vibebox/cli.log`, `.vibebox/vm_root.log` and `.vibebox/vm_manager.log`
42**Security**
43If you believe you’ve found a security issue, please avoid public disclosure. Open a private report via GitHub Security
44Advisories instead.