Skip to content

Commit

Permalink
Add pre-commit hook example to README
Browse files Browse the repository at this point in the history
  • Loading branch information
albertas committed Aug 10, 2024
1 parent 784d8b9 commit 3e8d394
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ ignore-names = ["BaseTestCase", "*Mixin"]
ignore-names-in-files = ["migrations"]
```

## Pre-commit hook
Create a `.pre-commit-config.yaml` file in the root of your project directory, if it doesn't exist, and add the following to the file:

```
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/albertas/deadcode
rev: 2.4.1
hooks:
- id: deadcode
```

## Command line options

| Option                                    | Type | Meaning |
Expand Down

0 comments on commit 3e8d394

Please sign in to comment.