Skip to content

Commit 96d7c42

Browse files
Zuulopenstack-gerrit
authored andcommitted
Merge "doc: clarify that pre-commit is optional"
2 parents 338ee65 + 167e338 commit 96d7c42

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/source/contributor/development-environment.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ OpenStack CI environment and replicate it in your test environment.
166166
Using the pre-commit hook
167167
=========================
168168

169-
Nova makes use of the `pre-commit framework <https://pre-commit.com/>`__ to
169+
Nova can make use of the `pre-commit framework <https://pre-commit.com/>`__ to
170170
allow running of some linters on each commit. This must be enabled locally to
171171
function:
172172

@@ -175,6 +175,10 @@ function:
175175
$ pip install --user pre-commit
176176
$ pre-commit install --allow-missing-config
177177
178+
As a reminder, the hooks are optional and you are not enforced to run them.
179+
You can either not install pre-commit or skip the hooks once by using the
180+
`--no-verify` flag on `git commit`.
181+
178182
Using a remote debugger
179183
=======================
180184

0 commit comments

Comments
 (0)