From 59c32d01a4880bd83e5e0843e0e250f812007b3e Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 17 Oct 2026 21:39:14 +0300 Subject: [PATCH] docs(standard): add RM3, a plain Links section to close the README --- docs/standard.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/standard.md b/docs/standard.md index 353a363..4babf91 100644 --- a/docs/standard.md +++ b/docs/standard.md @@ -397,6 +397,16 @@ a relative one 404s on the package page. `README.md` MUST open with a sentence that states the repo's one-liner ([MD1](#MD1)), then what the package does, then a minimal example. The sentence MAY reword the one-liner and add links. +### RM3 · Closing { #RM3 } + +`README.md` SHOULD end with a `## Links` section followed by a `` ## Part of `modern-python` `` +section that links to the org profile. `## Links` is a bulleted list, one link per item: the docs +site if one exists, then the PyPI page, then the license. It MAY add others, such as the Releases +page. Headings in `README.md` SHOULD NOT carry emoji. + +*Why:* GitHub's README outline and the PyPI page show every heading, so a heading per link reads as +a run of empty sections. + ## Metadata ### MD1 · One-liner { #MD1 }