Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.28 KB

Contributing Guidelines

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

General Guidelines

  1. Create a Pull Request for any contribution. Pull requests should include clear descriptions.
  2. 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.
  3. Everything must be documented following Rust conventions.
  4. All new functionality must include relevant unit and integration tests.

Local Development

  1. Install Rust (rustup is recommended). Instructions/
  2. Install Foundry. Anvil (from the Foundry toolkit) is required for functional tests with Solidity.
    curl -L https://foundry.paradigm.xyz | bash
    foundryup
  3. Run tests to ensure everything is working as expected.
    cargo test

Code of Conduct

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

Questions?

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

Thank you for contributing!