records: apply the reference rule of ADR 0037 to every record #657

Open
opened 2026-09-29 16:39:10 +00:00 by hexajon · 0 comments
Owner

What to change

Read every record against the reference rule of ADR 0037, and fix each one:

  • A plain path must name a file that exists in the committed tree. Fix the path, or remove it when the text does not need it.
  • A file in another repo is written as a full URL: host, owner, repo, branch, and path.
  • A file on a user's machine starts with ~/ or /. For example, the pi config paths in 0039 are not madtea files.
  • A function name, a test name, a line number after a path, or a count of code comes out. A test is described by what it checks, not by its name.

This goes further than #652, which covers only references to files and tests that no longer exist.

Acceptance

  • Every plain path in every record exists in the committed tree.
  • No record names a function, a test, a line number, or a count of code.
  • adr check passes.
## What to change Read every record against the reference rule of ADR 0037, and fix each one: - A plain path must name a file that exists in the committed tree. Fix the path, or remove it when the text does not need it. - A file in another repo is written as a full URL: host, owner, repo, branch, and path. - A file on a user's machine starts with `~/` or `/`. For example, the pi config paths in 0039 are not madtea files. - A function name, a test name, a line number after a path, or a count of code comes out. A test is described by what it checks, not by its name. This goes further than #652, which covers only references to files and tests that no longer exist. ## Acceptance - Every plain path in every record exists in the committed tree. - No record names a function, a test, a line number, or a count of code. - `adr check` passes.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
sixfold-space/madtea#657
No description provided.