diff --git a/.vscode/settings.json b/.vscode/settings.json index d5d24723f0..3e310b0b7b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -25,5 +25,6 @@ }, "yaml.schemas": { "http://json-schema.org/draft/2019-09/schema#": "values-schema.yaml" - } + }, + "shellformat.flag": "-i 2 -ci" } diff --git a/adr/2020-11-06-bash-style-guide.md b/adr/2020-11-06-bash-style-guide.md new file mode 100644 index 0000000000..cab7e73e7b --- /dev/null +++ b/adr/2020-11-06-bash-style-guide.md @@ -0,0 +1,15 @@ +Maurice: + +Seeing we have too many discussions around bash best practices we will settle for a style guide. +I don't see a point in discussing which one to choose, only to choose one that is used by very big corporation/community. +That is why I chose to start using this one: + +https://google.github.io/styleguide/shellguide.html + +Exceptions: + +- Keep file extensions for many reasons: easy for humans, ootb detection for most editors + +NOTE: + +Added flags to shell-format extension: "-i 2 -ci" to come close according to https://emacs.stackexchange.com/questions/32151/linter-for-google-shell-style-guide