docs: drop internal ticket IDs from test comments - #1398
Merged
Conversation
The repo is public and an outside reader cannot resolve a Linear ID. CLAUDE.md already says not to reference tickets in code comments; these two are the only occurrences in the tree, and both were introduced this week. Neither comment loses anything. The sentence after the colon was already carrying the explanation and the ID was decoration: 'The whole point of RAD-314: every terminal Backup phase...' -> 'Every terminal Backup phase...' Found while auditing scripts/velero-demo/README.md for the same thing before it shipped.
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.
Two code comments reference Linear IDs. The repo is public, an outside reader cannot resolve them, and CLAUDE.md already rules this out: "Don't reference tickets, PRs, bug numbers, or diff history... Those belong in the PR description and rot as the codebase evolves."
These are the only two occurrences in the tree, and both landed this week — same sentence pattern, written independently, both through review.
Neither comment loses anything. The clause after the colon was already doing the explaining; the ID was decoration:
Testing
git grep -E "\b(SKY|RAD|LIN)-[0-9]+"over tracked files: zero hits after, two before.go test ./internal/issues/...passes,gofmtclean. Comment-only change — no code touched.One note on how the count was verified, since it tripped someone already:
git grepin a working tree reports on that tree, including anyone's uncommitted changes. Both greps above were run against theorigin/mainref and against a worktree branched from it, not against a checkout carrying staged work.Note
Low Risk
Documentation-only comment edits with no runtime or test logic changes.
Overview
Comment-only cleanup in
internal/issuestests so public readers are not pointed at unresolvable internal ticket IDs.In
source_cnpg_test.goandsource_velero_test.go, the leading "The whole point of RAD-318/RAD-314:" clauses are removed. The behavioral intent of each test is unchanged—the comments still explain why the cases matter (CNPG terminal phases vs ready instances; Velero backup phases includingFailedValidation).Reviewed by Cursor Bugbot for commit 8fe61ff. Bugbot is set up for automated code reviews on this repo. Configure here.