document naming conventions #4 #30

blahosyl · Apr 14, 2024 · a4c3bfe · a4c3bfe
1 parent 6f9b4ee
commit a4c3bfe
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,18 @@ Which libraries are used and what their purpose is, why they are needed
 
 ## Testing
 
+### User story testing
+
+### Code validation
+
+#### Naming conventions used
+
+- all class names are in `CamelCase`.
+- all constant names are in `ALL_CAPS`.
+- all variable names are in `snake_case`.
+- following my mentor's suggestion, I changed the names of global variables (that are not constants) so that they always start with an underscore: `_global_variable`
+
+
 ### User input
 
 #### Y/N questions