Contributing

Feel free to dive in! Open an issue, start a discussion, or submit a PR.

Pre Requisites

You will need the following software on your machine:

In addition, familiarity with Solidity is requisite.

Clone this repository including submodules:

$ git clone --recurse-submodules -j8 git@github.com:PaulRBerg/prb-proxy.git

Then, inside the project's directory, run this to install the Node.js dependencies:

$ bun install

Now you can start making changes.

This repo uses Foundry for development and testing and git submodules for dependency management.

You can run the tests with the following command:

$ forge test

Forge will automatically install any missing dependencies.

You will need the following VSCode extensions: