Skip to content

Commit f9ea384

Browse files
committed
docs: add pre-commit requirement code quality checks to contributing guide
Signed-off-by: OneZero-Y <[email protected]>
1 parent 35c8ec8 commit f9ea384

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Thank you for your interest in contributing to the vLLM Semantic Router project!
1010
- [Running Tests](#running-tests)
1111
- [Development Workflow](#development-workflow)
1212
- [Code Style and Standards](#code-style-and-standards)
13+
- [Code Quality Checks](#code-quality-checks)
1314
- [Submitting Changes](#submitting-changes)
1415
- [Project Structure](#project-structure)
1516

@@ -191,6 +192,18 @@ The test suite includes:
191192

192193
## Code Style and Standards
193194

195+
### Code Quality Checks
196+
197+
Before submitting a PR, please run the pre-commit hooks to ensure code quality and consistency. **These checks are mandatory** and will be automatically run on every commit once installed.
198+
199+
```bash
200+
# Install pre-commit hooks
201+
pre-commit install
202+
203+
# Run all checks
204+
pre-commit run --all-files
205+
```
206+
194207
### Go Code
195208
- Follow standard Go formatting (`gofmt`)
196209
- Use meaningful variable and function names

0 commit comments

Comments
 (0)