From ad6ea23e06289547c67c223d13d6f5ccad6cfde7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karol=20Buja=C4=8Dek?= Date: Tue, 7 Jul 2020 15:38:13 +0200 Subject: [PATCH] Readme - add information about pre-commit validations --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6ce419b..11defad 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ We help companies build, run, deploy and scale software and infrastructure by em --- ![Terraform validation](https://github.com/lablabs/terraform-aws-eks-alb-ingress/workflows/Terraform%20validation/badge.svg?branch=master) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-success?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) ## Description @@ -52,6 +53,18 @@ No output. Feel free to create an issue in this repository if you have questions, suggestions or feature requests. +### Validation, linters and pull-requests + +We want to provide high quality code and modules. For this reason we are using +several [pre-commit hooks](.pre-commit-config.yaml) and +[GitHub Actions workflow](.github/workflows/main.yml). A pull-request to the +master branch will trigger these validations and lints automatically. Please +check your code before you will create pull-requests. See +[pre-commit documentation](https://pre-commit.com/) and +[GitHub Actions documentation](https://docs.github.com/en/actions) for further +details. + + ## License [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)