Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (44 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 1.86 KB
Raw

Contributing to Vault-0

Getting Started

  1. Fork the repo and clone your fork:
git clone https://github.com/<your-username>/Vault-0.git
cd Vault-0
  1. Install dependencies:
npm install
  1. Run in development mode:
cargo tauri dev

Requires Rust 1.75+, Node 18+, and Xcode Command Line Tools on macOS.

Making Changes

  1. Create a branch from main:
git checkout -b your-branch-name
  1. Keep files under 600 lines. Split into modules if needed.
  2. Run cargo clippy and cargo fmt before committing.
  3. Test your changes locally with cargo tauri dev.

Pull Requests

  1. One PR per feature or fix. Keep scope small.
  2. Write a clear title describing the change (e.g., "Add per-request spend tracking to proxy handler").
  3. Include a brief description of what changed and why.
  4. Link any related issue (e.g., "Closes #12").

What to Work On

Check the open issues for tasks labeled good first issue or help wanted. Current areas that need contribution:

  1. Per-request spend tracking — enforce spend_cap_cents across all proxied requests, not just x402 settlements.
  2. Wallet balance fetching — replace the stubbed get_wallet_balance() with real RPC calls to fetch on-chain USDC balance.
  3. Payment history persistence — store settled x402 payments to disk and return them from get_payment_history().
  4. Linux support — replace macOS Keychain calls with a cross-platform secret storage backend.
  5. Additional agent frameworks — extend the detection/migration flow beyond OpenClaw.

Reporting Issues

Open an issue with:

  1. What you expected to happen.
  2. What actually happened.
  3. Steps to reproduce.
  4. macOS version and architecture (Apple Silicon or Intel).

Code of Conduct

Be respectful. No harassment, no trolling. Focus on the code.