From 0ed2b3d5c5319dd160ea854407253ac0e649bcf8 Mon Sep 17 00:00:00 2001
From: petrucci4prez <natedwarshuis@gmail.com>
Date: Sun, 16 Jul 2017 03:59:40 -0400
Subject: [PATCH] add conventions?

---
 main.lua | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/main.lua b/main.lua
index afb7b5f..09bf18b 100644
--- a/main.lua
+++ b/main.lua
@@ -1,5 +1,17 @@
---CONVENTIONS:
---0: true, 1: false
+--[[
+Conventions:
+0 is true, 1 is false
+
+Var names:
+- Scope:
+  - local: no underscore
+  - module: single underscore
+  - global: double underscore
+  - required (imported): no underscore (same name as file)
+- Mutability
+  - variable: lowercase
+  - constant: all caps
+--]]
 
 local ABS_PATH = os.getenv('CONKY_LUA_HOME')