Contributions to OpenZeppelin Foundry Upgrades are welcome. Please review the information below to test out and contribute your changes.
The following prerequisites are required to build the project locally:
After the prerequisites are installed, the commands below can be run from this project's root directory.
yarn install
The dependencies must be installed at least once before running the tests or linter.
yarn test
Ensure that all tests pass. If you are adding new functionality, include testcases as appropriate.
yarn lint
If linting errors or warnings occur, run yarn lint:fix to attempt to auto-fix issues. If there are remaining issues that cannot be auto-fixed, manually address them and re-run the command to ensure it passes.
yarn docgen
As a contributor, we ask that you fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo. See "Fork-a-Repo" for how this works.