style: add initial style guide
Signed-off-by: Kevin Fenzi <kevin@scrye.com>
This commit is contained in:
parent
162e717943
commit
08bfe1d15e
1 changed files with 27 additions and 0 deletions
27
STYLEGUIDE
Normal file
27
STYLEGUIDE
Normal file
|
@ -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
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue