diff --git a/AGENTS.md b/AGENTS.md index e6ebb5d..90c74b1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -48,6 +48,10 @@ real fetch and worker loops against the fake, which retry, lease-expiry, and sch 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; a sibling test may be the one that trips. `tests/test_invariant_census.py` enforces that shape. diff --git a/README.md b/README.md index 43a3542..12fdeeb 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ The architecture of this package is heavily informed by Arseniy Popov's [PR #270 ## 📦 [PyPI](https://pypi.org/project/faststream-outbox) -## 📝 [License](LICENSE) +## 📝 [License](https://github.com/modern-python/faststream-outbox/blob/main/LICENSE) ## Part of `modern-python`