diff --git a/AGENTS.md b/AGENTS.md index 19d460d..a4aecec 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -25,9 +25,12 @@ bindings, and `import_checker.py` owns every optional-dependency probe. Read the Real work **not scheduled** becomes a GitHub issue. +Every link in `README.md` must be absolute: `https://github.com/modern-python//blob/main/`, +or `.../tree/main/` for a directory. Never a relative path: `README.md` is also the PyPI long +description, and PyPI does not rewrite relative links, so a relative one 404s on the package page. + An invariant is a test whose name is the claim, with a docstring opening `INVARIANT:` and a second paragraph naming **what breaks it** — design rationale, not a report of what this one test catches. -Nothing enforces that docstring shape; it is read at review time. ## Code style diff --git a/README.md b/README.md index 03a9440..1458a44 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ The following intentionally differ: ## 📦 [PyPI](https://pypi.org/project/lite-bootstrap) -## 📝 [License](LICENSE) +## 📝 [License](https://github.com/modern-python/lite-bootstrap/blob/main/LICENSE) ## Part of `modern-python`