Skip to content

Commit 28a766f

Browse files
committed
ci: add pre-commit hook to prevent README.md changes
README.md is frozen at v1 docs. The hook fails with a clear message directing contributors to edit README.v2.md instead.
1 parent 8fdd697 commit 28a766f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ repos:
5555
language: system
5656
files: ^(pyproject\.toml|uv\.lock)$
5757
pass_filenames: false
58+
- id: readme-v1-frozen
59+
name: README.md is frozen (v1 docs)
60+
entry: README.md is frozen at v1. Edit README.v2.md instead.
61+
language: fail
62+
files: ^README\.md$
5863
- id: readme-snippets
5964
name: Check README snippets are up to date
6065
entry: uv run --frozen python scripts/update_readme_snippets.py --check

0 commit comments

Comments
 (0)