Skip to content

Commit 0f95963

Browse files
committed
add precommit hooks info
1 parent 7d05452 commit 0f95963

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

docs/introduction/contributing.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,21 @@ In windows:
6666
```bash
6767
python -m unittest
6868
```
69+
70+
## Pre-commit Hooks
71+
72+
You can use pre-commit hooks to ensure code quality before committing changes, and be sure that certain pipeline checks will pass.
73+
74+
```bash
75+
python -m pip install pre-commit
76+
pre-commit install
77+
pre-commit run --all-files
78+
```
79+
80+
Currently ruff, bandit and gitleaks are configured to run as pre-commit hooks.
81+
82+
To skip pre-commit hooks use:
83+
84+
```bash
85+
git commit --no-verify -m "Your commit message"
86+
```

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav:
1212
- Contributing: introduction/contributing.md
1313
- License: introduction/license.md
1414
- Protocol Use Cases: introduction/use-cases.md
15-
- Security Overview: introduction/security-scanning.md
15+
- Security Scan Overview: introduction/security-scanning.md
1616
- Handbook:
1717
- Expose Python Objects: beginners-guide/articles/servers.md
1818
- Using Clients: beginners-guide/articles/object-proxy.md

0 commit comments

Comments
 (0)