Skip to content

Commit b20fa3e

Browse files
authored
docs(standard): add RM3, a plain Links section to close the README (#132)
1 parent 99a0153 commit b20fa3e

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎docs/standard.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,16 @@ a relative one 404s on the package page.
397397
`README.md` MUST open with a sentence that states the repo's one-liner ([MD1](#MD1)), then what
398398
the package does, then a minimal example. The sentence MAY reword the one-liner and add links.
399399

400+
### RM3 · Closing { #RM3 }
401+
402+
`README.md` SHOULD end with a `## Links` section followed by a `` ## Part of `modern-python` ``
403+
section that links to the org profile. `## Links` is a bulleted list, one link per item: the docs
404+
site if one exists, then the PyPI page, then the license. It MAY add others, such as the Releases
405+
page. Headings in `README.md` SHOULD NOT carry emoji.
406+
407+
*Why:* GitHub's README outline and the PyPI page show every heading, so a heading per link reads as
408+
a run of empty sections.
409+
400410
## Metadata
401411

402412
### MD1 · One-liner { #MD1 }

0 commit comments

Comments
 (0)