Skip to content

docs: add pre-commit requirement code quality checks to contributing #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 5, 2025
Merged

docs: add pre-commit requirement code quality checks to contributing #60

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9ea384
docs: add pre-commit requirement code quality checks to contributing …
OneZero-Y Sep 5, 2025
985eaac
Merge branch 'main' into docs/improve-contributing
rootfs Sep 5, 2025
8bd33ee
docs: install pre-commit step
OneZero-Y Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Thank you for your interest in contributing to the vLLM Semantic Router project!
- [Running Tests](#running-tests)
- [Development Workflow](#development-workflow)
- [Code Style and Standards](#code-style-and-standards)
- [Code Quality Checks](#code-quality-checks)
- [Submitting Changes](#submitting-changes)
- [Project Structure](#project-structure)

Expand Down Expand Up @@ -191,6 +192,31 @@ The test suite includes:

## Code Style and Standards

### Code Quality Checks

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.

**Step 1: Install pre-commit tool**
```bash
# Using pip (recommended)
pip install pre-commit

# Or using conda
conda install -c conda-forge pre-commit

# Or using homebrew (macOS)
brew install pre-commit
```

**Step 2: Install pre-commit hooks for this repository**
```bash
# Install pre-commit hooks
pre-commit install
Copy link
Collaborator

@rootfs rootfs Sep 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this installs pre-commit on local git. can you add a step to explain how to install pre-commit too?

Copy link
Contributor Author

@OneZero-Y OneZero-Y Sep 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok ,please review it.


# Run all checks
pre-commit run --all-files
```

### Go Code
- Follow standard Go formatting (`gofmt`)
- Use meaningful variable and function names
Expand Down
Loading