add a small comment to summarize the pre-commit config

colour-science · Jan 3, 2025 · affff94 · affff94
1 parent 1a49fff
commit affff94
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,10 @@
+# The pre-commit steps used by colour are:
+# * codespell
+# * isort
+# * ruff-format
+# * ruff --fix
+# * blacken-docs
+# * prettier (with specific fixes)
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v5.0.0"