Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 1.31 KB
Raw

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.

Set Up

Clone this repository including submodules:

$ git clone --recurse-submodules -j8 [email protected]: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.

Development

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.

Syntax Highlighting

You will need the following VSCode extensions: