diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d504785e1c5578391ff635a3e563a73e72061bd0..0a8b888b993e43910a9fb9b9b8ff0e35523bd64f 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