Add comments about pre-commit hooks and how to disable them temporarily

posit-dev · Mar 12, 2024 · 6f84637 · 6f84637
1 parent a5c3b87
commit 6f84637
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,7 @@
+# For the rare case that you'd like to commit with no pre-commit hooks, you can use `--no-verify` in the commit call.
+# ```
+# git commit --no-verify -m "MSG"
+# ```
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.3.2

diff --git a/README.md b/README.md
@@ -57,3 +57,5 @@ pre-commit install
 # To disable:
 # pre-commit uninstall
 ```
+
+If you absolutely need to skip the pre-commit hooks, you can use the [`--no-verify` flag when you commit](https://git-scm.com/docs/githooks#_pre_commit) (`git commit --no-verify -m "MSG"`).