Contributing guidelines
Local Development
Changing Rust Code
Please make sure that the following commands pass if you have changed the code:
We are using the stable toolchain for building and testing, but the nightly toolchain for formatting and linting, as it allows us to use the latest features of rustfmt
and clippy
.
If you are working in VSCode, we recommend you install the rust-analyzer extension, and use the following VSCode user settings:
Changing Solidity code
Setup
Install foudryup and foundry
Running tests
Code formatting
Contract Analysis
We use Slither to detect any potential vulnerabilities in our contracts.
To run locally, simply install Slither in your conda env and run it inside the foundry directory.
Creating a Pull Request
We use conventional commits as our convention for formatting commit messages and PR titles.
Last updated