From 1be22f2860180e4c80cf6b8ddfc728bd2b1dd1f8 Mon Sep 17 00:00:00 2001
From: Mark <mark@openappstack.net>
Date: Fri, 26 Mar 2021 14:18:24 +0100
Subject: [PATCH] Change documentation of pre commit
---
.pre-commit-config.yaml | 2 ++
CONTRIBUTING.md | 8 ++++++--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 732d3b768..096db8e0c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -20,10 +20,12 @@ repos:
hooks:
- id: hadolint
- repo: https://github.com/jazzband/pip-tools
+ # Makes sure the requirements.txt file is up to date
rev: 5.2.1
hooks:
- id: pip-compile
- repo: https://github.com/timothycrosley/isort
+ # Sorts import statements for you
rev: 5.0.9
hooks:
- id: isort
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 28045f363..d504785e1 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -15,8 +15,12 @@ before each commit. Use the following commands to install the hooks
pre-commit install
```
-Running the pre-commit for the first time usually takes a little longer because `pre-commit`
-pulls some of it's hooks from upstream repositories.
+Running `git commmit` for the first time after installing the hook usually takes a
+little longer because `pre-commit` pulls it's hooks from upstream repositories.
+You can find all hooks in `.pre-commit-config.yaml`.
+
+In case you need to skip the execution of the pre-commit hooks (please don't!),
+use `git commit --no-verify`.
## Adding dependencies
--
GitLab