From 0a8c638411f1da47ed137ed91739662d687dd0b8 Mon Sep 17 00:00:00 2001 From: Varac <varac@varac.net> Date: Tue, 30 Mar 2021 21:51:54 +0200 Subject: [PATCH] Add hadolint, shellcheck and shfmt to CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d504785e1..0a8b888b9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,8 +8,19 @@ Make sure you have development dependencies installed in your development enviro pip install -r requirements-dev.txt ``` -We use `pre-commit` to maintain and install pre-commit hooks that should be executed -before each commit. Use the following commands to install the hooks +## pre-commit hooks + +We use [pre-commit](https://pre-commit.com/) to maintain and install pre-commit +hooks that should be executed before each commit. + + +Please install these required tools on your system: + +* [hadolint](https://github.com/hadolint/hadolint) for linting the `Dockerfile` +* [shellcheck](https://www.shellcheck.net/) and +* [shfmt](https://github.com/mvdan/sh) to lint and validate shell scripts + +Then install pre-commit hooks: ``` pre-commit install -- GitLab