Merge pull request #91 from sanafayyaz315/pre-commit-hooks-clean

chore: add ruff, markdownlint, and file-hygiene pre-commit hooks

Author: sanafayyaz315

.pre-commit-config.yaml

@@ -20,3 +20,41 @@ repos:
           - --subject-min-length=10
           - --subject-max-length=72
           - --allow-breaking
+
+  # Standard file-hygiene hooks (run before linters so they see clean files)
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        args: [--allow-multiple-documents]
+        exclude: ^charts/
+      - id: check-json
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+      - id: debug-statements
+      - id: check-case-conflict
+      - id: mixed-line-ending
+      - id: no-commit-to-branch
+        args: [--branch=main]
+      - id: detect-private-key
+
+  # Ruff — Python linting and formatting
+  # Rules are defined in ruff.toml at the repo root
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.11
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  # Markdownlint — Markdown linting
+  # Rules are defined in .markdownlint.jsonc at the repo root
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.22.1
+    hooks:
+      - id: markdownlint-cli2
+        args: [--fix]

CONTRIBUTING.md

@@ -23,7 +23,51 @@ uv tool install pre-commit
 pre-commit install --install-hooks
 ```
 
-After this, every `git commit` will automatically validate your commit message format (see below).
+After this, every `git commit` will automatically run the checks listed in [Pre-commit hooks](#pre-commit-hooks) on your staged files. Commits that fail any check will be blocked.
+
+If you haven't run `pre-commit install --install-hooks`, hooks will **not** run automatically. In that case, you can run all checks manually before committing:
+
+```bash
+pre-commit run --all-files
+```
+
+## Pre-commit hooks
+
+The following hooks run automatically on every commit. They are defined in [`.pre-commit-config.yaml`](.pre-commit-config.yaml).
+
+### Conventional commits
+
+Enforces the [Conventional Commits](https://www.conventionalcommits.org/) format on commit messages (see [Commit message conventions](#commit-message-conventions) below). Runs at the `commit-msg` stage.
+
+### Python linting and formatting (ruff)
+
+Two hooks from [ruff](https://docs.astral.sh/ruff/):
+
+- **ruff** — lints Python files and auto-fixes issues. Rules are defined in [`ruff.toml`](ruff.toml).
+- **ruff-format** — enforces consistent formatting (quotes, indentation, line length).
+
+### Markdown linting (markdownlint)
+
+Lints `.md` files and auto-fixes what it can (e.g., list indentation, code block languages). Rules are defined in [`.markdownlint.jsonc`](.markdownlint.jsonc); ignored paths in [`.markdownlint-cli2.yaml`](.markdownlint-cli2.yaml).
+
+### File-hygiene hooks
+
+General-purpose checks from [pre-commit/pre-commit-hooks](https://github.com/pre-commit/pre-commit-hooks):
+
+| Hook | What it does |
+| ---- | ------------ |
+| `trailing-whitespace` | Removes trailing whitespace from all files |
+| `end-of-file-fixer` | Ensures every file ends with a newline |
+| `check-yaml` | Validates YAML syntax (excludes `charts/` — Helm templates use Go syntax) |
+| `check-json` | Validates JSON syntax |
+| `check-toml` | Validates TOML syntax |
+| `check-merge-conflict` | Detects leftover merge conflict markers |
+| `check-added-large-files` | Blocks files larger than 1 MB |
+| `debug-statements` | Catches leftover `breakpoint()` / `pdb` calls in Python |
+| `check-case-conflict` | Detects filenames that differ only in case |
+| `mixed-line-ending` | Ensures consistent line endings (no mixed LF/CRLF) |
+| `no-commit-to-branch` | Blocks direct commits to `main` |
+| `detect-private-key` | Catches accidentally committed private keys |
 
 ## Linting and formatting
 

agents/a2a/langgraph_crewai_agent/src/a2a_langgraph_crewai/images/rh_logo.svg

@@ -127,7 +127,7 @@ See: [Model Deployment](https://github.com/red-hat-data-services/red-hat-ai-exam
 
 - Open the **deployment details**. Under **Inference endpoint**, copy the **external** URL (only if you enabled the external route).
 - **Deployment URL** for the MCP server is the **predict** endpoint, for example:
-  - `<EXTERNAL_BASE_URL>/v1/models/<MODEL_NAME>:predict`  
+  - `<EXTERNAL_BASE_URL>/v1/models/<MODEL_NAME>:predict`
   where `<MODEL_NAME>` is the deployment’s **Resource name** (lowercase, no spaces). Example: `https://my-model-myproject.apps.example.com/v1/models/my-churn-model:predict`
 - **Token** (if you enabled token auth): **Projects** → *your project* → **Deployments** → expand the deployment → use the **Token secret** value as `DEPLOYMENT_TOKEN`.
 

agents/autogen/mcp_agent/images/rh_logo.svg

@@ -23,7 +23,7 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = [
-    "pytest>=9.0.2,<10.0.0",  
+    "pytest>=9.0.2,<10.0.0",
 ]
 
 [tool.setuptools]

agents/autogen/mcp_agent/mcp_automl_template/AUTOML_DEPLOYMENT.md

@@ -17,4 +17,3 @@ MODEL_ID=ollama/llama3.1:8b
 # MLFLOW_WORKSPACE=default
 # LLM_PROVIDER=litellm
 # MLFLOW_TRACKING_AUTH= # Use Kubernetes service account for authentication (if running inside the cluster)
-

agents/autogen/mcp_agent/mcp_automl_template/pyproject.toml

@@ -8,7 +8,7 @@ requires-python = ">=3.12,<3.14"
 dependencies = [
     "fastapi>=0.135.1",
     "uvicorn[standard]>=0.41.0",
-    "crewai[litellm]>=1.11.0",    
+    "crewai[litellm]>=1.11.0",
     "litellm!=1.82.7,!=1.82.8", # Block compromised PyPI releases
     "python-dotenv>=1.1.1,<1.2.0",  # CrewAI pins ~=1.1.1
     "setuptools>=80.9.0,<82.0.0",

agents/crewai/websearch_agent/.env.example

@@ -10,4 +10,4 @@ API_KEY=not-needed-for-local-development
 #PORT=
 
 ## Deployment Configuration (for OpenShift/Kubernetes)
-#CONTAINER_IMAGE=
+#CONTAINER_IMAGE=

agents/crewai/websearch_agent/pyproject.toml

@@ -2283,4 +2283,4 @@
   "action_name": null,
   "action_description": null,
   "access_type": "PRIVATE"
-}
+}