Skip to content

Commit 6cf15d7

Browse files
committed
Document pre-commit
AI Prompts: claude-sonnet-4-6: <ide_opened_file>The user opened the file ./docs/contributing.rst in the IDE. This may or may not be related to the current task.</ide_opened_file> add pre-commit to the prerequisites and install steps
1 parent 1cdff63 commit 6cf15d7

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Contribution Guide
2+

docs/contributing.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Prerequisites
99
- Python 3.10 or later
1010
- Git
1111
- ``make``
12+
- `pre-commit <https://pre-commit.com/#install>`_
1213

1314
Getting started
1415
---------------
@@ -31,6 +32,12 @@ This runs ``python3 -m venv .venv`` and then ``pip install -e ".[dev]"``,
3132
which installs ``pytest``, ``sphinx``, and ``sphinx-autobuild`` alongside the
3233
extension itself.
3334

35+
Install the pre-commit hooks so they run automatically on every commit:
36+
37+
.. code-block:: bash
38+
39+
pre-commit install
40+
3441
Building the docs
3542
-----------------
3643

0 commit comments

Comments
 (0)