Skip to content

Commit

Permalink
Add missing docs about the git pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
Kutu committed Jun 2, 2024
1 parent 535434c commit 051faf2
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ just check
just docs
```

A git pre-commit hook that will run `just check` at every commit and block it if something is wrong can be installed with:
```sh title="Command Line"
just install-hook
```

You can uninstall it with:
```sh title="Command Line"
just uninstall-hook
```

See more recipes with:
```sh title="Command Line"
just help
Expand Down
3 changes: 2 additions & 1 deletion src/knuckles/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from importlib.metadata import version

from ._api import RequestMethod
from ._media_retrieval import SubtitlesFileFormat
from ._subsonic import Subsonic
Expand Down Expand Up @@ -27,7 +29,6 @@
from .models._system import License, SubsonicResponse
from .models._user import User
from .models._video import AudioTrack, Captions, Video, VideoInfo
from importlib.metadata import version

__version__ = version("knuckles")

Expand Down
3 changes: 2 additions & 1 deletion tests/api/test_system.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
from importlib.metadata import version
from typing import Any

import responses
from dateutil import parser
from knuckles import Subsonic, __version__
from responses import Response
from importlib.metadata import version

from tests.conftest import AddResponses


Expand Down

0 comments on commit 051faf2

Please sign in to comment.