Skip to content

Commit 67f3cab

Browse files
committed
Address PR review: trim pre-commit section, rename CICD doc, mark 0.1.0 MVP
- Shorten CLAUDE.md pre-commit section to a brief blurb pointing at the CI/CD reference doc - Rename docs/CICD_PLAN.md -> docs/CICD.md as the living reference; retitle and fix the reference in pyproject.toml - Change CHANGELOG 0.1.0 from Pre-release to MVP Signed-off-by: aviv ron <rona@il.ibm.com>
1 parent 2b1b638 commit 67f3cab

4 files changed

Lines changed: 7 additions & 27 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ This project uses [semantic versioning](https://semver.org/).
99

1010
## [Unreleased]
1111

12-
## [0.1.0]Pre-release
12+
## [0.1.0]MVP
1313

14-
Initial pre-release. API is not yet stable.
14+
Initial MVP release. API is not yet stable.

CLAUDE.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -376,29 +376,9 @@ skipped for this reason.
376376

377377
## Pre-commit
378378

379-
This repo uses [pre-commit](https://pre-commit.com/) with ruff (lint + format), nbstripout,
380-
a local `validate-links` hook (broken local links, stale labels, and broken first-party imports
381-
in `.ipynb`/`.md`/`.py`; script lives at `.pre-commit/validate_links.py`), local SPDX-header and
382-
DCO-signoff checks, `uv-lock`, and the standard hygiene hooks (whitespace, EOF, YAML/TOML
383-
validity, merge conflicts, large files, case conflicts, line endings).
379+
**See [docs/CICD.md](docs/CICD.md) for the full CI/CD setup — pre-commit hook list, setup steps, and what runs on every commit vs. in CI.**
384380

385-
After cloning:
386-
387-
```bash
388-
uv run pre-commit install
389-
git config blame.ignoreRevsFile .git-blame-ignore-revs
390-
```
391-
392-
Hooks run on `git commit`. Most are auto-fixing - if a hook modifies files, re-stage and
393-
commit again. Do NOT use `--no-verify` to bypass; fix the underlying issue instead. Run
394-
`uv run pre-commit run --all-files` to apply hooks across the full tree, and
395-
`uv run pre-commit autoupdate` periodically to bump pinned hook versions.
396-
397-
What is intentionally NOT in pre-commit (run in CI instead):
398-
399-
- `pytest` (GPU tests, vLLM - too slow for commit time)
400-
- `mypy` / type checking (too slow)
401-
- Notebook execution
381+
This repo uses [pre-commit](https://pre-commit.com/) (ruff, hygiene hooks, SPDX-header and DCO-signoff checks, and a local link validator) to enforce quality before a commit lands. Hooks run automatically on `git commit` and most are auto-fixing, so re-stage and commit again if a hook modifies files. Do NOT use `--no-verify` to bypass — fix the underlying issue instead.
402382

403383
## Documentation
404384

docs/CICD_PLAN.md renamed to docs/CICD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# CI/CD Plan
1+
# CI/CD
22

3-
This document describes the CI/CD setup for granite-switch — what runs locally, what runs on every PR, and the roadmap for future automation.
3+
This document is the reference for the CI/CD setup for granite-switch — what runs locally, what runs on every PR, and the roadmap for future automation.
44

55
## Local: Pre-commit Hooks
66

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ conflicts = [
8080

8181
[tool.coverage.run]
8282
source = ["granite_switch"]
83-
# CI's coverage run executes only tests/unit/ (the CPU-safe set — see docs/CICD_PLAN.md).
83+
# CI's coverage run executes only tests/unit/ (the CPU-safe set — see docs/CICD.md).
8484
# The subpackages below are structurally untestable there: they need a GPU, real model
8585
# checkpoints, or deps CI doesn't install (vLLM/tutorials). Their coverage is measured on
8686
# the GPU cluster, not here. Omitting them keeps the CI coverage number meaningful — it

0 commit comments

Comments
 (0)