pre-commit: Add comment with usage instructions to config file

1 files changed, 41 insertions, 0 deletions

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 8b1d72f80a..bf047356e6 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,3 +1,44 @@
+# This is the configuration file for the pre-commit framework, a simple way
+# to manage, install and run git hooks to catch common problems early on.
+# See https://pre-commit.com/ for details.
+#
+# This adds the following hooks:
+#
+# - check-case-conflict
+# - check-byte-order-marker
+# - check-yaml
+# - check-json
+# - check-xml
+# - mixed-line-ending
+# - end-of-file-fixer
+# - trailing-whitespace
+# - no-commit-to-branch
+# - eslint
+# - clang-format
+# - qsscheck
+#
+# If you have python and python-pip installed, just run:
+#
+#     $ pip install --user pre-commit
+#     $ git clone https://github.com/mixxxdj/mixxx.git
+#     $ cd mixxx
+#     $ pre-commit install
+#     $ pre-commit install -t pre-push
+#
+# It will now run relevant hooks automatically on every `git commit` or
+# `git push` in the mixxx git repository.
+#
+# If you have a problems with a particular hook, you can use the `$SKIP`
+# environment variable to disable hooks:
+#
+#     $ SKIP=clang-format,end-of-file-fixer git commit
+#
+# This can also be used to separate logic changes and autoformatting into
+# two subsequent commits.
+#
+# Using the `$SKIP` var is preferable to using `git commit --no-verify`
+# because it won't prevent catching other, unrelated issues.
+
 exclude: ^lib/.*$
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks