docs: contributing: style: Naming Conventions

pdxjohnny · pdxjohnny · commit abe44a282e57 · 2020-03-07T16:23:53.000-08:00
Signed-off-by: John Andersen &lt;johnandersenpdx@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Docstrings and doctestable examples for `record.py` (features and evaluated)
 - Simplified model API with SimpleModel
 - Documentation on how DataFlows work conceptually.
+- Style guide now contains information on class, variable, and function naming.
 ### Changed
 - Restructured contributing documentation
 - Use randomly generated data for scikit tests
diff --git a/docs/contributing/style.rst b/docs/contributing/style.rst
@@ -42,6 +42,12 @@ on all JavaScript files. Use the following options.
 
     $ js-beautify -r -n -s 2 file_to_format.js
 
+Naming Conventions
+------------------
+
+- Variables should always use underscores, as well as functions and methods.
+- Classes should use CamelCase.
+
 Imports
 -------
 
