Commit 6ee425d9 authored by clabby's avatar clabby Committed by GitHub

Update packages/contracts-bedrock/CONTRIBUTING.md

Co-authored-by: default avatarrefcell.eth <abigger87@gmail.com>
parent 14eff736
...@@ -103,7 +103,7 @@ To lock a contract variable, add it to the `layout-lock.json` file which has the ...@@ -103,7 +103,7 @@ To lock a contract variable, add it to the `layout-lock.json` file which has the
} }
``` ```
With the above config, the `validate-spacers` hardhat task will check that we have a contract called `MyContractName`, that the contract has a variable named `myVariableName`, and that the variable is in the correct position as defined in the lock file. With the above config, the `validate-spacers` script will check that we have a contract called `MyContractName`, that the contract has a variable named `myVariableName`, and that the variable is in the correct position as defined in the lock file.
You should add things to the `layout-lock.json` file when you want those variables to **never** change. You should add things to the `layout-lock.json` file when you want those variables to **never** change.
Layout locking should be used in combination with diffing the `.storage-layout` file in CI. Layout locking should be used in combination with diffing the `.storage-layout` file in CI.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment