Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
120 lines (81 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

120 lines (81 loc) · 2.57 KB

Contributing to Meld

Welcome! We're glad you're interested in contributing to Meld.

Development Setup

Prerequisites

  • Rust (stable toolchain)
  • Cargo
  • Git
  • Python (for pre-commit hooks)
  • Nix (optional, for building Rocq proofs via Bazel)

Getting Started

# Clone the repository
git clone https://github.com/pulseengine/meld.git
cd meld

# Install pre-commit hooks
pip install pre-commit
pre-commit install

# Build the project
cargo build

# Run tests
cargo test

Code Quality

We use several tools to maintain code quality:

Pre-commit Hooks

We use pre-commit to run checks before each commit:

  • cargo fmt: Format code according to Rust style guidelines
  • cargo clippy: Run static analysis with clippy lints
  • cargo test: Run all tests

To run pre-commit hooks manually:

pre-commit run --all-files

Clippy Configuration

Our clippy configuration treats all warnings as errors (-D warnings). See clippy.toml for details.

Common clippy lints we enforce:

  • dead_code: Find unused code
  • unnecessary_lazy_evaluations: Avoid unnecessary closures
  • unnecessary_cast: Avoid redundant type casts
  • useless_conversion: Avoid redundant conversions
  • len_zero: Prefer is_empty() over len() > 0
  • clone_on_copy: Avoid cloning Copy types
  • derivable_impls: Use #[derive] when possible

Formatting

We use rustfmt for consistent code formatting:

# Format all code
cargo fmt

# Check formatting
cargo fmt --all -- --check

Testing

Run the full test suite:

cargo test --all

Proof Verification

If you have Nix installed, you can verify the Rocq proofs:

bazel build //proofs/transformations/merge:merge_spec
bazel build //proofs/spec:fusion_spec

Pull Request Process

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes and commit them with pre-commit hooks
  4. Push to your fork and submit a pull request
  5. Ensure all CI checks pass

Code Style

  • Follow Rust API guidelines
  • Use descriptive variable and function names
  • Add documentation comments for public APIs
  • Keep functions focused and small
  • Write tests for new functionality

Documentation

Update documentation when making changes:

  • Update README.md for user-facing changes
  • Update CONTRIBUTING.md for development process changes
  • Add doc comments for new public APIs

License

By contributing to Meld, you agree that your contributions will be licensed under the Apache License 2.0.