Skip to content

Commit bb60a43

Browse files
committed
chore: update readme
1 parent 5f91162 commit bb60a43

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ To enable dependency scanning, an extra tool is required: scancode-toolkit
3939
pip3 install -r requirements-scancode.txt
4040
```
4141

42+
### Pre-commit Setup
43+
This project uses pre-commit hooks to ensure code quality and consistency. To set up pre-commit, run:
44+
```bash
45+
pip3 install pre-commit
46+
pre-commit install
47+
```
48+
49+
This will install the pre-commit tool and set up the git hooks defined in the `.pre-commit-config.yaml` file to run automatically on each commit.
50+
4251
### Devcontainer Setup
4352
To simplify the development environment setup, a devcontainer configuration is provided. This allows you to develop inside a containerized environment with all necessary dependencies pre-installed.
4453

0 commit comments

Comments
 (0)