Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1019 Bytes

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1019 Bytes
Raw

Contributing to Firmalyzer

Thank you for your interest in contributing! 🎉

Development Setup

Prerequisites

  • Rust 1.70+ (with cargo)
  • Python 3.8+
  • maturin (pip install maturin)

Local Development

# Clone the repo
git clone https://github.com/ismailtsdln/firmalyzer.git
cd firmalyzer

# Build Rust core and install Python package
cd python
maturin develop

# Run tests
cd ../core
cargo test --no-default-features

Code Style

  • Rust: Follow standard rustfmt formatting. Run cargo fmt before committing.
  • Python: We use ruff for linting. Run ruff check python/firmalyzer/ before committing.

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests and lints
  5. Commit with clear messages
  6. Push and open a Pull Request

Adding Plugins

See the Plugin Development section in the README.

Questions?

Open an issue on GitHub!