Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 572eff9

Browse files
committed
Added references to pre-commit installation
1 parent 5297e5b commit 572eff9

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

docs/developer/how-to/lint.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ commit`` on just the files that have changed::
1515

1616
$ pre-commit install
1717

18+
It is also possible to `automatically enable pre-commit on cloned repositories <https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories>`_.
19+
This will result in pre-commits being enabled on every repo your user clones from now on.
20+
1821
Fixing issues
1922
-------------
2023

docs/user/how-to/existing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ This will:
2020

2121
To enable publishing to PyPI see `../how-to/pypi`
2222

23+
.. note::
24+
25+
To install the pre-commit see `../../developer/how-to/lint`
26+
2327
Example merge
2428
-------------
2529

docs/user/tutorials/new.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ project or github Organization.
4949

5050
see `../how-to/pypi`
5151

52+
Setting up pre-commit
53+
---------------------
54+
55+
To install the pre-commit see `../../developer/how-to/lint`.
56+
5257
Running the tests
5358
-----------------
5459

0 commit comments

Comments
 (0)