From 282380d8cc080528f9398e44035f9bedf505ff32 Mon Sep 17 00:00:00 2001 From: Patrick Robertson Date: Fri, 14 Mar 2025 14:20:32 +0000 Subject: [PATCH] Add note on skipping pre-commit hook --- docs/source/development/style_guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/development/style_guide.md b/docs/source/development/style_guide.md index c3764c1..390f11a 100644 --- a/docs/source/development/style_guide.md +++ b/docs/source/development/style_guide.md @@ -17,6 +17,9 @@ poetry run pre-commit install Ruff can also be to run automatically. Alternative: Ruff can also be [integrated with most editors](https://docs.astral.sh/ruff/editors/setup/) for real-time formatting. +If you wish to disable the pre-commit hook (for example, if you want to commit some WIP code) you can use the `--no-verify` flag when you commit. +For example: `git commit -m "WIP Code" --no-verify` + ### **Linting (Check Before Pushing) 🔍** We recommend you also run the linter before pushing code.