Skip to content

docs: write README links absolute so they resolve on PyPI #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lesnik512 merged 1 commit into from
Sep 7, 2026
Merged

docs: write README links absolute so they resolve on PyPI #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ Release and move `v0` by hand, or cut a new patch tag.

Real work **not scheduled** becomes a GitHub issue.

Every link in `README.md` must be absolute: `https://github.com/modern-python/<repo>/blob/main/<path>`,
or `.../tree/main/<path>` 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.
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ jobs:
semvertag auto-detects GitHub Actions, picks the bump from the latest
commit, and creates the tag ref via the GitHub API. `fetch-depth: 0`
matters — the default `1` misses tag-relative history. See
[GitHub Actions docs](docs/providers/github.md) for token scopes,
[GitHub Actions docs](https://github.com/modern-python/semvertag/blob/main/docs/providers/github.md) for token scopes,
GitHub Enterprise setup, outputs, and troubleshooting.

## Strategies
Expand All @@ -103,7 +103,7 @@ semvertag stands on other `modern-python` libraries:
- **[modern-di-typer](https://github.com/modern-python/modern-di-typer)** —
dependency-injection wiring for the Typer CLI. semvertag resolves its
settings, API providers, and bump strategies through a `modern_di` container
([`semvertag/ioc.py`](semvertag/ioc.py)).
([`semvertag/ioc.py`](https://github.com/modern-python/semvertag/blob/main/semvertag/ioc.py)).
- **[httpware](https://github.com/modern-python/httpware)** — the resilient
HTTP client both providers use for the GitLab/GitHub REST calls (retries,
timeouts, typed decoding, secret redaction).
Expand All @@ -112,7 +112,7 @@ semvertag stands on other `modern-python` libraries:

## 📦 [PyPI](https://pypi.org/project/semvertag)

## 📝 [License](LICENSE)
## 📝 [License](https://github.com/modern-python/semvertag/blob/main/LICENSE)

## Part of `modern-python`

Expand Down
Loading