Let CONTRIBUTING name the mirror, and keep the guard able to fail #1081

Merged
jaylouisw merged 1 commit from fix/canonical-contributing-exemption into main 2026-11-08 15:26:55 +00:00
Owner

#1074 moved contributions to GitHub — accounts here are closed, so that is the only door a
stranger has — and in doing so tripped the guard that says CONTRIBUTING may not mention GitHub.

That assertion was right when the forge was the only door and is wrong now, but the fix is not to
delete it. README.md stays forbidden, and CONTRIBUTING is allowed only on conditions that are
themselves asserted:

  • it must still carry the canonical forge URL;
  • it must call GitHub the mirror, not a second source of truth;
  • its exemption must say why, in a sentence a reader can judge.

So the pair of checks survives in a stronger form: the failure that would actually hurt — a
contributor following a stale instruction to clone from the wrong place — still goes red.

test/canonical-urls.test.js: 43 passed, 0 failed.

Closes #1080.

`#1074` moved contributions to GitHub — accounts here are closed, so that is the only door a stranger has — and in doing so tripped the guard that says CONTRIBUTING may not mention GitHub. That assertion was right when the forge was the only door and is wrong now, but the fix is not to delete it. `README.md` stays forbidden, and CONTRIBUTING is allowed only on conditions that are themselves asserted: - it **must** still carry the canonical forge URL; - it **must** call GitHub the mirror, not a second source of truth; - its exemption **must** say why, in a sentence a reader can judge. So the pair of checks survives in a stronger form: the failure that would actually hurt — a contributor following a stale instruction to clone from the wrong place — still goes red. `test/canonical-urls.test.js`: 43 passed, 0 failed. Closes #1080.
Let CONTRIBUTING name the mirror, and keep the guard able to fail
Some checks failed
CI / Test (Node 18) (pull_request) Failing after 1m33s
CI / Test (Node 20) (pull_request) Failing after 1m32s
CI / Server smoke test (pull_request) Successful in 24s
CI / Docker build (pull_request) Successful in 9s
CI / Test (Node 22) (pull_request) Failing after 1m37s
c6b2f0415b
The guard asserted that CONTRIBUTING must not be exempt, because it is where contributors
are told what to do. That was true while the forge was the only door. Accounts here are
closed by design, so it now has to send contributors to the GitHub mirror - and the guard
refuses any file containing that URL.

Deleting the assertion would be the wrong fix. The invariant that matters is narrower and is
now asserted in its place: CONTRIBUTING may name the mirror, but it must still carry the
canonical forge URL, must call GitHub the mirror rather than a second source of truth, and
must carry an exemption that says why. README.md stays forbidden.

43 passed, 0 failed.
jaylouisw deleted branch fix/canonical-contributing-exemption 2026-11-08 15:26:58 +00:00
Sign in to join this conversation.
No reviewers
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!1081
No description provided.