Skip to content

Commit 3f1d3be

Browse files
authored
README updates for pre-commit (#71)
* README updates for pre-commit * black fix
1 parent 126ac7d commit 3f1d3be

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,21 @@ The Django application depends on a separate model server to perform the task su
99
## Using pre-commit
1010

1111
Pre-commit should be used before pushing a new PR.
12-
To use pre-commit you need to first install it and it's dependencies by running:
12+
To use pre-commit, you need to first install the pre-commit package and its dependencies by running:
1313

1414
```bash
1515
pip install -r requirements-dev.txt
1616
```
1717

18-
once installed you can run the hooks with:
18+
19+
To install pre-commit into your git hooks and run the checks on every commit, run the following each time you clone this repo:
20+
21+
```bash
22+
pre-commit install
23+
```
24+
25+
26+
To update the pre-commit config to the latest repos' versions and run the precommit check across all files, run:
1927

2028
```bash
2129
pre-commit autoupdate && pre-commit run -a

ansible_wisdom/main/urls.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@
4141
name='login',
4242
),
4343
path('logout/', auth_views.LogoutView.as_view(), name='logout'),
44-
path('', include('django_prometheus.urls'))
44+
path('', include('django_prometheus.urls')),
4545
]

0 commit comments

Comments
 (0)