docs(readme): add notes about bash formatting

This commit is contained in:
Stanislas Lange 2020-04-27 15:26:20 +02:00
parent b4cbb54320
commit 08aeed2c5b
1 changed files with 4 additions and 0 deletions

View File

@ -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