Commit 81264e44 authored by Maurelian's avatar Maurelian

docs(ctb): Document the correct approach to defining immutable variables

parent 6911bdc7
...@@ -45,6 +45,18 @@ We also have the following custom tags: ...@@ -45,6 +45,18 @@ We also have the following custom tags:
- Event parameters should NOT be prefixed with an underscore. - Event parameters should NOT be prefixed with an underscore.
#### Immutable variables
Immutable variables:
- should be in `SCREAMING_SNAKE_CASE`
- should be `internal`
- should have a hand written getter function
This approach clearly indicates to the developer that the value is immutable, without exposing
the non-standard casing to the interface. It also ensure that we don’t need to break the ABIs if
we switch between values being in storage and immutable.
#### Spacers #### Spacers
We use spacer variables to account for old storage slots that are no longer being used. We use spacer variables to account for old storage slots that are no longer being used.
......
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