openstack/nova
Code Issues Proposed changes

Merge "doc: clarify that pre-commit is optional"

Browse Source
This commit is contained in:
Zuul
2023-11-10 19:26:38 +00:00
committed by Gerrit Code Review
parent 338ee65c4c 167e3380c9
commit 96d7c42e27
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/contributor/development-environment.rst
View File

@@ -166,7 +166,7 @@ OpenStack CI environment and replicate it in your test environment.
Using the pre-commit hook Using the pre-commit hook
========================= =========================
Nova makes use of the `pre-commit framework <https://pre-commit.com/>`__ to Nova can make use of the `pre-commit framework <https://pre-commit.com/>`__ to
allow running of some linters on each commit. This must be enabled locally to allow running of some linters on each commit. This must be enabled locally to
function: function:
@@ -175,6 +175,10 @@ function:
$ pip install --user pre-commit $ pip install --user pre-commit
$ pre-commit install --allow-missing-config $ pre-commit install --allow-missing-config
As a reminder, the hooks are optional and you are not enforced to run them.
You can either not install pre-commit or skip the hooks once by using the
`--no-verify` flag on `git commit`.
Using a remote debugger Using a remote debugger
======================= =======================