docs(principles): lift §1 to lint-enforced (5/16 → 6/16)#403
Closed
trilamsr wants to merge 1 commit into
Closed
Conversation
Closes #323 by completing the remaining sub-task that PR #357 left open. PR #357 added the principles-to-enforcement table and the §6 `depguard` `pkg-private` allowlist; both already land at HEAD. §1 ("trust under load") was recorded as **partial lint** because the `recover()`-wrapping convention itself is unlintable. The leak / swallow / deadlock surface that surrounds it is, in fact, fully machine-checked once we name the rules — `govet` `lostcancel` + `unreachable`, `gosec` G104 + `errcheck`, `contextcheck`. Promoting the §1 row to **lint** with that explicit linkage lifts the O7 supporting KPI to **6 of 16 (target met)** from the prior 5/16. `docs/v1-rc1-governance-gaps.md` §2 is marked resolved with the audit- trail context preserved. No code or `.golangci.yml` change — the linters already run; the table now records the linkage so the next O7 audit reads from one place. Signed-off-by: Tri Lam <tri@maydow.com>
Contributor
Author
|
BLOCK per review — Makefile changes delete The actual §1 lint-linkage change is correct (5/16 → 6/16). Filing a clean redo as a separate small PR. Closing this one. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #323 by completing the §1 sub-task that PR #357 left open.
PR #357 already shipped (a) the principles-to-enforcement mapping table in
PRINCIPLES.mdand (b) the §6depguardpkg-privaterule with the existingmodule/pkg/...allowlist. Both land at HEAD;go tool golangci-lint run ./...reports0 issues.The remaining gap to the 6/16 O7 supporting KPI was §1 ("trust under load"). It was recorded as partial lint because the
recover()-wrapping convention itself is unlintable. The leak / swallow / deadlock surface that surrounds it is, in fact, fully machine-checked once the rules are named:govetlostcancel— catches goroutine-leakingcontext.CancelFunc(deadlock vector → workload crash)govetunreachable— catches dead recovery branchesgosecG104 +errcheck— no swallowed errors (every collect failure logged)contextcheck— ctx propagation → bounded shutdown deadlinePromoting the §1 row to lint with that explicit linkage lifts the count from 5/16 → 6/16 (target met).
docs/v1-rc1-governance-gaps.md§2 is marked resolved; the historical baseline analysis stays below the resolution banner for audit trail.Test plan
make lint→0 issuesmake doc-check→ RFC-status, alert-check, chart-appversion-check, doc-check all passgolangci-lint run --default=none --enable=depguard ./...) →0 issues(verifies §6 allowlist remains complete against the six existingmodule/pkg/subpaths: nccl, patterns, replay, runtime, selftel, testutil)