Skip to content

Commit 63dfdf6

Browse files
committed
docs(standard): restate the standard as numbered requirements with BCP 14 key words
1 parent f97ce16 commit 63dfdf6

3 files changed

Lines changed: 372 additions & 199 deletions

File tree

‎AGENTS.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ before naming a mark, a colourway, or a surface.
1212
## Repository metadata
1313

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

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

2121
A repo may be listed on the org profile **before** its package reaches PyPI. Its
2222
Downloads badge 404s until pepy indexes it; the Stars badge and repo link resolve

‎CONTEXT.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,17 @@ The written, normative description of what makes a repo a modern-python repo, ow
6464
and published on the org site. A repo either meets it, or carries an exemption.
6565
_Avoid_: guidelines, conventions, rules — each reads as advisory, and the standard is not.
6666

67+
**Requirement**:
68+
One numbered statement of the standard, cited by its stable ID (`CI6`). A MUST or MUST NOT
69+
requirement is core; a SHOULD is a recommendation; a MAY is a permission.
70+
_Avoid_: rule, check — a check is what verifies a requirement, not the requirement.
71+
6772
**Core**:
68-
The subset of the standard a repo must meet. Everything the standard describes outside the core is
69-
free.
73+
The standard's MUST and MUST NOT requirements, which a repo must meet. Everything outside the core
74+
is a recommendation or a permission.
7075
_Avoid_: baseline, required set
7176

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

0 commit comments

Comments
 (0)