Skip to content

Commit

Permalink
docs: pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
frank-bee committed Oct 30, 2024
1 parent bcac30a commit 155a94c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
11 changes: 11 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Developer documentation for the project.

# Pre-commit hooks (DRAFT / POC)
This project uses pre-commit hooks to ensure that code is formatted correctly and so on.
To install pre-commit tool run:
```bash
pip install pre-commit
pre-commit install
```
Now the hooks will run on every commit.
See also [.pre-commit-config.yaml](./.pre-commit-config.yaml) for the configuration.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@

!! THIS PROJECT IS UNDER CONSTRUCTION !!

<img src="./misc/under-construction.jpg" alt="Under Construction" width="300"/>
<img src="./misc/under-construction.jpg" alt="Under Construction" width="300"/>
<figcaption>
Foto from Mabel Amber from <a href="https://www.pexels.com/de-de/foto/nahaufnahme-fotografie-der-roten-und-weissen-strassenbeschilderung-117602/" target="_blank" style="color: #555;">Pexels</a>
</figcaption>

## Development
Developer documentation for the project see [DEVELOPMENT.md](./DEVELOPMENT.md).

0 comments on commit 155a94c

Please sign in to comment.