From 08bfe1d15eac639ffdec07758f709df55656f717 Mon Sep 17 00:00:00 2001
From: Kevin Fenzi <kevin@scrye.com>
Date: Fri, 21 Jun 2019 20:53:30 +0000
Subject: [PATCH] style: add initial style guide

Signed-off-by: Kevin Fenzi <kevin@scrye.com>
---
 STYLEGUIDE | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 STYLEGUIDE

diff --git a/STYLEGUIDE b/STYLEGUIDE
new file mode 100644
index 0000000000..7a6863035b
--- /dev/null
+++ b/STYLEGUIDE
@@ -0,0 +1,27 @@
+infrastructure ansible style guide
+==================================
+
+* run changes through 'ansible-review'. 
+  ERRORs must be corrected or rules changed. 
+  WARNs should be corrected.
+
+  Rules changes can be proposed to 
+  https://pagure.io/cpe/ansible-review-templates/ 
+
+* Use 'yml' instead of 'yaml' 
+
+* do add '.j2' to the end of templates
+
+* in general let readablity trump grepability, ie: 
+
+DONT:
+- name: This is some play
+  module: name=thing arg=thing2 anotherlongerarg=thing arg4=anodheranth
+  
+DO:
+- name: This is some play
+  module:
+  - name: thing
+  - arg: thing2
+..etc
+