Skip to content

docs(standard): restate the standard as numbered requirements with BCP 14 key words #112

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 2 commits into from
Sep 25, 2026
+382 −209
Merged

docs(standard): restate the standard as numbered requirements with BCP 14 key words #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63dfdf6
docs(standard): restate the standard as numbered requirements with BC…
lesnik512 Sep 25, 2026
a63dd13
Merge remote-tracking branch 'origin/main' into docs/standard-require…
lesnik512 Sep 25, 2026
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
6 changes: 3 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ before naming a mark, a colourway, or a surface.
## Repository metadata

A repo's description, topics, keywords, classifiers and `[project.urls]` follow
[section 11 of the standard](https://modern-python.org/standard/#11-metadata).
[the standard's metadata requirements](https://modern-python.org/standard/#metadata) (MD1 to MD6).

The org profile's `coverage 100%` badge is static and deliberately unlinked: there is no
org-level coverage URL to point at, and the gate in section 5 of the standard is what
makes the claim true.
org-level coverage URL to point at, and the gate in
[TS2](https://modern-python.org/standard/#TS2) is what makes the claim true.

A repo may be listed on the org profile **before** its package reaches PyPI. Its
Downloads badge 404s until pepy indexes it; the Stars badge and repo link resolve
Expand Down
11 changes: 8 additions & 3 deletions CONTEXT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,17 @@ The written, normative description of what makes a repo a modern-python repo, ow
and published on the org site. A repo either meets it, or carries an exemption.
_Avoid_: guidelines, conventions, rules — each reads as advisory, and the standard is not.

**Requirement**:
One numbered statement of the standard, cited by its stable ID (`CI6`). A MUST or MUST NOT
requirement is core; a SHOULD is a recommendation; a MAY is a permission.
_Avoid_: rule, check — a check is what verifies a requirement, not the requirement.

**Core**:
The subset of the standard a repo must meet. Everything the standard describes outside the core is
free.
The standard's MUST and MUST NOT requirements, which a repo must meet. Everything outside the core
is a recommendation or a permission.
_Avoid_: baseline, required set

**Exemption**:
A recorded, reasoned deviation of one repo from one part of the core.
A recorded, reasoned deviation of one repo from one or more core requirements.
_Avoid_: exception, override — both already mean something in the DI repos; deviation, drift — a
deviation nobody recorded is drift, not an exemption.
Loading
Loading