The canonical-URL guard forbids the one file that must now name GitHub #1080

Closed
opened 2026-11-08 15:23:57 +00:00 by jaylouisw · 0 comments
Owner

test/canonical-urls.test.js asserts:

x CONTRIBUTING is not exempt - it is where contributors are told what to do

That was correct while the forge was the only door. It no longer is: accounts here are closed by
design, so CONTRIBUTING.md must send contributors to the GitHub mirror, and the guard refuses any
file that contains github.com/Jaylouisw/packetforge.

Suppressing the failure would be the wrong fix, and so would deleting the assertion. The invariant
that actually matters is narrower: CONTRIBUTING may name the mirror, but it must still present the
forge as the canonical home, must call GitHub what it is, and must carry a reasoned exemption.

Acceptance:

  • The assertion is replaced by one that encodes the two-door arrangement rather than forbidding it.
  • The replacement can fail: if CONTRIBUTING stopped naming the forge, or stopped calling GitHub a
    mirror, or the exemption lost its reason, the suite goes red.
  • README.md stays forbidden — it is the file everyone follows.
`test/canonical-urls.test.js` asserts: ``` x CONTRIBUTING is not exempt - it is where contributors are told what to do ``` That was correct while the forge was the only door. It no longer is: accounts here are closed by design, so **CONTRIBUTING.md must send contributors to the GitHub mirror**, and the guard refuses any file that contains `github.com/Jaylouisw/packetforge`. Suppressing the failure would be the wrong fix, and so would deleting the assertion. The invariant that actually matters is narrower: CONTRIBUTING may name the mirror, but it must still present the forge as the canonical home, must call GitHub what it is, and must carry a reasoned exemption. Acceptance: - The assertion is replaced by one that encodes the two-door arrangement rather than forbidding it. - The replacement can fail: if CONTRIBUTING stopped naming the forge, or stopped calling GitHub a mirror, or the exemption lost its reason, the suite goes red. - README.md stays forbidden — it is the file everyone follows.
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.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge#1080
No description provided.