From 08aeed2c5b28757ca834bfb066d08fd99e41e3c1 Mon Sep 17 00:00:00 2001 From: Stanislas Lange Date: Mon, 27 Apr 2020 15:26:20 +0200 Subject: [PATCH] docs(readme): add notes about bash formatting --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bd82d07..a786a5f 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,10 @@ Solutions that provision a ready to use OpenVPN server based on this script in o - AWS using Terraform at [`openvpn-terraform-install`](https://github.com/dumrauf/openvpn-terraform-install) +## Contributing / Code formatting + +We use [shellcheck](https://github.com/koalaman/shellcheck) and [shfmt](https://github.com/mvdan/sh) to enforce bash styling guidelines and good practices. They are executed for each commit / PR with GitHub Actions, so you can check the configuration [here](https://github.com/angristan/openvpn-install/blob/master/.github/workflows/push.yml). + ## Security and Encryption