Skip to content

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

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lesnik512 merged 1 commit into from
Oct 17, 2026
Merged

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

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
10 changes: 10 additions & 0 deletions docs/standard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down
Loading