Skip to content

Commit

Permalink
README updates for pre-commit (#71)
Browse files Browse the repository at this point in the history
* README updates for pre-commit

* black fix
  • Loading branch information
robinbobbitt authored Feb 3, 2023
1 parent 126ac7d commit 3f1d3be
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,21 @@ The Django application depends on a separate model server to perform the task su
## Using pre-commit

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

```bash
pip install -r requirements-dev.txt
```

once installed you can run the hooks with:

To install pre-commit into your git hooks and run the checks on every commit, run the following each time you clone this repo:

```bash
pre-commit install
```


To update the pre-commit config to the latest repos' versions and run the precommit check across all files, run:

```bash
pre-commit autoupdate && pre-commit run -a
Expand Down
2 changes: 1 addition & 1 deletion ansible_wisdom/main/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@
name='login',
),
path('logout/', auth_views.LogoutView.as_view(), name='logout'),
path('', include('django_prometheus.urls'))
path('', include('django_prometheus.urls')),
]

0 comments on commit 3f1d3be

Please sign in to comment.