From 09215e117aee2f2a4cfe1f391cf4719188579333 Mon Sep 17 00:00:00 2001 From: Sam Al-Sapti Date: Mon, 28 Nov 2022 19:24:49 +0100 Subject: [PATCH] Add 'Contributing' section --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index c96782a7..d27ba9fd 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,18 @@ $ ./deploy.sh --vagrant services SINGLE_SERVICE # deploy SINGLE_SERVICE Docker Note that the `--vagrant` flag should be the first argument when using the script. +## Contributing + +If you want to contribute, you can fork the repository and submit a pull +request. We use a pre-commit hook for linting the YAML files before +every commit, so please use that. To initialize pre-commit, you need to +have Python and GNU make installed. Then, just run the following shell +command: + +```console +$ make init +``` + ## Nice tools - [J2Live](https://j2live.ttl255.com/): A live Jinja2 parser, nice to