From 86f84c0cc4babe1680fc3fad21d370fc9107a5d7 Mon Sep 17 00:00:00 2001 From: martgras Date: Sun, 25 Mar 2018 14:57:25 +0200 Subject: [PATCH] Adding Style Guidelines --- DNS-API-Dev-Guide.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/DNS-API-Dev-Guide.md b/DNS-API-Dev-Guide.md index cb122bd..53c097b 100644 --- a/DNS-API-Dev-Guide.md +++ b/DNS-API-Dev-Guide.md @@ -192,4 +192,13 @@ https://github.com/Neilpang/acme.sh/issues/1261 2. Add your dns api to the support list: https://github.com/Neilpang/acme.sh/tree/dev#8-automatic-dns-api-integration +## Style Guidelines +acme.sh uses shellcheck for new commits and also enforces style guidelines. +To avoid the most common travis failures: + +* Use indentation with 2 spaces +* remove trailing spaces +* Doublequote variables (use echo _debug "txtvalue=$txtvalue" instead of _debug txtvalue=$txtvalue) +* Always check the travis results after a commit +* Consider using shellcheck (https://www.shellcheck.net/) before commiting