aboutsummaryrefslogtreecommitdiffstats
path: root/docs/style-guide.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/style-guide.rst')
-rw-r--r--docs/style-guide.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index d2de5287..511236b9 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -874,6 +874,28 @@ No::
x = y+z;
x +=1;
+***************
+Order of Layout
+***************
+
+Layout contract elements in the following order:
+
+1. Import statements
+2. Interfaces
+3. Libraries
+4. Contracts
+
+Inside each contract, library or interface, use the following order:
+
+1. Type declarations
+2. State variables
+3. Events
+4. Functions
+
+.. note::
+
+ It might be clearer to declare types close to their use in events or state
+ variables.
******************
Naming Conventions