Skip to content

[chore] Update Makefile and best practices to match black selection vs ruff format (with doc fixes) #1302

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 1 commit into from
Oct 21, 2025
Merged

[chore] Update Makefile and best practices to match black selection vs ruff format (with doc fixes) #1302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -801,7 +801,7 @@ images:
# help: pydocstyle - Docstring style checker
# help: pycodestyle - Simple PEP-8 checker
# help: pre-commit - Run all configured pre-commit hooks
# help: ruff - Ruff linter + formatter
# help: ruff - Ruff linter + (eventually) formatter
# help: ty - Ty type checker from astral
# help: pyright - Static type-checking with Pyright
# help: radon - Code complexity & maintainability metrics
Expand Down Expand Up @@ -1064,8 +1064,9 @@ pre-commit: ## 🪄 Run pre-commit hooks
fi
@/bin/bash -c "source $(VENV_DIR)/bin/activate && pre-commit run --all-files --show-diff-on-failure"

ruff: ## ⚡ Ruff lint + format
@echo "⚡ ruff $(TARGET)..." && $(VENV_DIR)/bin/ruff check $(TARGET) && $(VENV_DIR)/bin/ruff format $(TARGET)
ruff: ## ⚡ Ruff lint + (eventually) format
@echo "⚡ ruff $(TARGET)..." && $(VENV_DIR)/bin/ruff check $(TARGET)
# && $(VENV_DIR)/bin/ruff format $(TARGET)

# Separate ruff targets for different modes
ruff-check:
Expand All @@ -1074,6 +1075,7 @@ ruff-check:
ruff-fix:
@echo "⚡ ruff check --fix $(TARGET)..." && $(VENV_DIR)/bin/ruff check --fix $(TARGET)

# Nothing depends on this target yet, but kept for future and ad hoc use
ruff-format:
@echo "⚡ ruff format $(TARGET)..." && $(VENV_DIR)/bin/ruff format $(TARGET)

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/best-practices/mcp-best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Best Practices

## Input and output santitization
## Input and output sanitization

Ensure your inputs and outputs are sanitized. In Python, we recommend using Pydantic V2.

Expand Down Expand Up @@ -44,7 +44,7 @@ Make targets are grouped by functionality. Use `make help` to see them all in yo

| Target | Description |
|----------------------|-------------|
| `make lint` | Run all linters (e.g., `ruff check`, `ruff format`). |
| `make lint` | Run all linters (e.g., `ruff check`, `black`, `isort`). |

#### 🐳 CONTAINER BUILD & RUN

Expand All @@ -69,7 +69,7 @@ Each repo must include a `Containerfile` (Podman-compatible, Docker-compatible)

### Containerfile Requirements:

- Must start from a secure base (e.g., latest Red Hat UBI9 minimal image `registry.access.redhat.com/ubi9-minimal:9.5-1741850109`)
- Must start from a secure base (e.g., latest Red Hat UBI10 minimal image `registry.access.redhat.com/ubi10-minimal:10.0-1755721767`)
- Should use `uv` or `pdm` to install dependencies via `pyproject.toml`
- Must run the server using the same entry point as `make serve`
- Should expose relevant ports (`EXPOSE 8080`)
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ weasyprint>=66.0
webcolors>=24.11.1
webencodings>=0.5.1
zipp>=3.23.0
zopfli>=0.2.3.post1
zopfli>=0.2.3.post1
Loading