Skip to content

Commit 5771d89

Browse files
committed
Add pre-commit as a requirement.
1 parent 57761ee commit 5771d89

4 files changed

Lines changed: 7 additions & 8 deletions

File tree

.github/workflows/lint.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@ jobs:
2323
- name: Install dependencies
2424
run: |
2525
npm install
26-
pip install -r ./docs/requirements.txt
27-
pip install pre-commit
26+
pip install -r ./requirements.txt
2827
dotnet tool restore
2928
- name: Run linters
3029
run: |

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ sphinx:
1414

1515
python:
1616
install:
17-
- requirements: docs/requirements.txt
17+
- requirements: requirements.txt

CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,10 @@ Prerequisites:
2323
- Node 24 or later
2424
- Python 3.12 or later
2525
- .NET SDK 10.0 or later
26-
- [pre-commit](https://pre-commit.com)
2726

2827
After cloning, set up the tools and dependencies.
2928

3029
```powershell
31-
# Register pre-commit hooks (runs linters before commits)
32-
pre-commit install
33-
3430
# Set up your Python virtual environment
3531
python3 -m venv .venv
3632
@@ -39,9 +35,12 @@ python3 -m venv .venv
3935
4036
# Restore dependencies
4137
npm install
42-
pip install -r ./docs/requirements.txt
38+
pip install -r ./requirements.txt
4339
dotnet tool restore
4440
41+
# Register pre-commit hooks (runs linters before commits)
42+
pre-commit install
43+
4544
# When you're done, deactivate your virtual environment.
4645
deactivate
4746
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ sphinx>=9.1.0
22
sphinx-autobuild>=2024.10.3
33
sphinx_rtd_theme>=3.1.0
44
doc8>=1.1.1
5+
pre-commit>=4.3.0

0 commit comments

Comments
 (0)