Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (32 loc) · 995 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 995 Bytes
Raw

Contributing to Lumora Contracts

Dev Environment Setup

  1. Install Rust: https://rustup.rs
  2. Add Wasm target: 
    rustup target add wasm32-unknown-unknown
  3. Install Soroban CLI: 
    cargo install --locked soroban-cli --features opt
  4. Copy env file: 
    cp .env.example .env

Running Tests

cargo test

PR Guidelines

  • Every PR must include unit tests for new functionality
  • All PRs must pass cargo clippy -- -D warnings
  • Use conventional commit messages: feat:, fix:, chore:, docs:, test:
  • One issue per PR — never combine multiple issues

Security Checklist

  • Never commit private keys or secret values
  • Always use require_auth for privileged operations
  • Follow the CEI pattern (Checks-Effects-Interactions)
  • Validate all inputs before state changes

Resources