Skip to content

docs(standard): add RM3, a plain Links section to close the README - #132

Merged
lesnik512 merged 1 commit into
mainfrom
docs/readme-links-footer
Oct 17, 2026
Merged

lesnik512 merged 1 commit into
mainfrom
docs/readme-links-footer

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Adds RM3 to the standard. It says how a README ends: a ## Links list (docs site if there is one, PyPI, license), then the existing "Part of modern-python" section. It also says README headings should not carry emoji.

Today most repos end with one H2 heading per link, each with an emoji (## 📚 [Documentation](...)). GitHub's outline and the PyPI page list those as sections with no content. The footer was never written down, so repos have drifted:

  • 6 repos have three link headings, 17 have two, and 4 have one.
  • httpware puts them on one line with dots between.
  • compose2pod and release-scope have none.

RM3 is a SHOULD rather than a dated MUST. It is cosmetic, and nothing in CI or tooling depends on it. The repo sweep to bring READMEs in line comes after the open humanizer PRs merge, so no README has two PRs open against it at once.

just test passes and mkdocs build --strict is clean.

This was referenced Oct 17, 2026
@lesnik512
lesnik512 merged commit b20fa3e into main Oct 17, 2026
3 checks passed
@lesnik512
lesnik512 deleted the docs/readme-links-footer branch October 17, 2026 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant