Skip to content

Commit

Permalink
Update dev docs and pre-commit config
Browse files Browse the repository at this point in the history
  • Loading branch information
maxnoe committed Feb 23, 2024
1 parent 5ce3da2 commit e158a41
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ repos:
- id: end-of-file-fixer

- repo: https://github.com/codespell-project/codespell
rev: v2.2.4
rev: v2.2.6
hooks:
- id: codespell
additional_dependencies:
- tomli

- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.2.1
rev: v0.2.2
hooks:
- id: ruff
args: [--fix, --show-fixes]
Expand Down
7 changes: 4 additions & 3 deletions docs/developer-guide/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,16 +116,17 @@ test plugin via
$ pip install -e ./test_plugin
We are using the ``black`` and ``isort`` auto-formatters for automatic
adherence to the code style (see our :doc:`/developer-guide/style-guide`).
We are using the ``pre-commit``, ``code-spell`` and ``ruff`` tools
for automatic adherence to the code style
(see our :doc:`/developer-guide/style-guide`).
To enforce running these tools whenever you make a commit, setup the
`pre-commit hook <https://pre-commit.com/>`_:

.. code-block:: console
$ pre-commit install
The pre-commit hook will then execute the tools with the same settings as when the a pull request is checked on github,
The pre-commit hook will then execute the tools with the same settings as when a pull request is checked on GitHub,
and if any problems are reported the commit will be rejected.
You then have to fix the reported issues before tying to commit again.
Note that a common problem is code not complying with the style guide, and that whenever this was the only problem found,
Expand Down

0 comments on commit e158a41

Please sign in to comment.