Remove GitHub issue-number references from code comments#1669
Merged
mstomar125 merged 1 commit intoJul 15, 2026
Conversation
Ahead of moving the docs/decision record into NodeSpace itself, sweep the Rust/TS/Svelte sources and reword provenance comments that hard-referenced GitHub issue numbers (`NodeSpaceAI#1234`, `Issue NodeSpaceAI#665`, `nodespace-sync#125`, `epic NodeSpaceAI#237`) to describe the behavior or constraint directly. Where a decision is captured by an ADR, the ADR reference is kept and only the ticket number dropped. Comment content only — no code, string literals, test fixtures, attributes, or formatting were changed (verified: the code portion of every touched line is byte-identical). Issue numbers inside string literals, assertion messages, log messages, test titles, fixtures, hex colors, and `#[...]` attributes were deliberately left intact, as were third-party references (e.g. an upstream tauri-apps/tray-icon bug) reduced to prose. Closes NodeSpaceAI#1494 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
APPROVE (adversarial re-review by author)
Meets the acceptance criteria for the comment sweep. |
3 tasks
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
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
One-time cleanup ahead of moving the docs/decision record into NodeSpace itself: sweep the Rust/TS/Svelte sources and reword provenance comments that hard-referenced GitHub issue numbers (
#1234,Issue #665,nodespace-sync#125,epic #237) to describe the behavior/constraint directly. Where a decision is captured by an ADR, the ADR reference is kept and only the ticket number dropped.Scope
212 files, ~810 references reworded, across every workspace package that carried them:
Comment content only — verified
The code portion of every touched line is byte-identical; only comment text changed. Verified mechanically: of the changed lines, 1744 are pure-comment lines and the remaining ~26 are block-comment continuation lines (
<!-- -->//** */doc blocks) or inlinecode; //comments whose code prefix is unchanged.Deliberately left intact (not comments): issue numbers inside string literals, assertion/log messages, test titles, fixtures (
'Invoice #001'), CSS/Svelte hex colors (#333), and#[...]attributes. Third-party references were reduced to prose (e.g. an upstreamtauri-apps/tray-iconbug), not linked by number.Testing
Full pre-push gate green:
bun run test:all+cargo build --bin nodespaced+bun run test:e2e+cargo test -p nodespace-app. Because the change is comment-only, it cannot affect compilation or behavior.Note on
quality:fix:bun run quality:fixcurrently fails on a pre-existing clippy warning inpackages/daemon/src/services/import_service.rs:645(if !(exists && !replace)can be simplified) that is present on cleanmainand unrelated to this sweep. Itscargo fmtstep also wants to reformat pre-existing formatting drift in files this sweep does not touch. Both are left out of scope here to keep this PR strictly comment-only; they are pre-existing tech debt for a separate cleanup.Acceptance criteria
bun run test:all+ full gate green)bun run quality:fix— blocked by a pre-existing, unrelated clippy warning (see note); the sweep itself is lint/format-neutralCloses #1494 (child of the cross-repo epic #1493)