Skip to content

Commit 061ddab

Browse files
committed
[DOCS] add pre-commit content at CONTRIBUTING.md
1 parent be34db1 commit 061ddab

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ FastAPI-fastkit uses following stacks:
2323
- Python 3.12.4
2424
- click 8.1.7
2525
- rich 13.9.2
26+
- pre-commit
2627

2728
### Local dev configuration
2829

@@ -85,6 +86,19 @@ git commit -m '[FEAT] Add new FastAPI template for microservices'
8586
git commit -m '[FIX] Fix virtual environment activation in Windows'
8687
```
8788

89+
#### Pre-commit
90+
91+
You can use pre-commit to automatically run linting, formatting, and type checking before committing.
92+
93+
```bash
94+
# Install pre-commit hooks
95+
pre-commit install
96+
```
97+
98+
After installing pre-commit hooks, the pre-commit hooks will be run automatically when you commit.
99+
100+
Check the pre-commit's output when you making new commit, and fix the code if there are any errors.
101+
88102
## Documentation
89103

90104
Follow these documentation guidelines:

0 commit comments

Comments
 (0)