Skip to content

Commit 4119046

Browse files
committed
docs: retire ADR numbers rather than renumbering the survivors
Also refresh the two stale 0001 names in docs/agents/domain.md.
1 parent d34950a commit 4119046

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

‎AGENTS.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ Every link in `README.md` must be absolute: `https://github.com/modern-python/<r
3939
or `.../tree/main/<path>` for a directory. Never a relative path: `README.md` is also the PyPI long
4040
description, and PyPI does not rewrite relative links, so a relative one 404s on the package page.
4141

42+
An ADR's number is a permanent address. Fold a record into another or drop it, but leave its
43+
number retired rather than renumbering the survivors: the citations that matter most live
44+
outside this repo — in issue bodies, commit messages, review threads — where no gate can follow
45+
a rename, so a renumber silently points them at whichever record takes the number next.
46+
4247
## Code Style
4348

4449
- The core package stays **zero-dependency**; PyYAML is the optional `[yaml]` extra and nothing else

‎docs/agents/domain.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Single-context repo:
1717
/
1818
├── CONTEXT.md
1919
├── docs/adr/
20-
│ ├── 0001-healthcheck-start-period-retries-passthrough.md
20+
│ ├── 0001-healthcheck-wait-budget-is-not-coupled-to-retries.md
2121
│ └── 0002-zero-dependency-core.md
2222
└── compose2pod/
2323
```
@@ -32,4 +32,4 @@ If the concept you need isn't in the glossary yet, that's a signal: either you'r
3232

3333
If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
3434

35-
> _Contradicts ADR-0001 (healthcheck start period retries passthrough), but worth reopening because…_
35+
> _Contradicts ADR-0001 (the healthcheck wait budget is not coupled to `retries`), but worth reopening because…_

0 commit comments

Comments
 (0)