Contributing Guidelines

Thank you for your interest in contributing to our project! This document provides guidelines and steps for contributing.

General Guidelines

Create a Pull Request for any contribution. Pull requests should include clear descriptions.
Pull requests titles should follow Conventional Commits specifications. Pull requests may contain any number of commits. Commit messages do not need to follow Conventional Commits.
Everything must be documented following Rust conventions.
All new functionality must include relevant unit and integration tests.

Install Rust (rustup is recommended). Instructions/
Install Foundry. Anvil (from the Foundry toolkit) is required for functional tests with Solidity.
```
curl -L https://foundry.paradigm.xyz | bash
foundryup
```
Run tests to ensure everything is working as expected. Note: compress-zkeys is excluded because ARK point decompression is expensive and only needed for release builds.
```
cargo test --workspace
```

Please note that this project is released with a Code of Conduct. By participating in this project, you agree to abide by its terms.

Feel free to reach out to the maintainers if you have any questions.

Thank you for contributing!