Skip to content

Remove GitHub issue-number references from code comments#1669

Merged
mstomar125 merged 1 commit into
NodeSpaceAI:mainfrom
mstomar125:issue-1494-remove-issue-refs
Jul 15, 2026
Merged

Remove GitHub issue-number references from code comments#1669
mstomar125 merged 1 commit into
NodeSpaceAI:mainfrom
mstomar125:issue-1494-remove-issue-refs

Conversation

@mstomar125

Copy link
Copy Markdown
Contributor

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:

Package Files ~Refs
core 47 ~400
desktop-app (.ts/.svelte/src-tauri) ~140 ~360
agent + nlp-engine 18 ~40
daemon + nodespace-types 7 ~16

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 inline code; // 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 upstream tauri-apps/tray-icon bug), 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:fix currently fails on a pre-existing clippy warning in packages/daemon/src/services/import_service.rs:645 (if !(exists && !replace) can be simplified) that is present on clean main and unrelated to this sweep. Its cargo fmt step 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

  • No GitHub issue-number references remain in code comments (excluding process mechanics)
  • Provenance comments reworded to describe behavior, not tickets
  • Tests pass (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-neutral

Closes #1494 (child of the cross-repo epic #1493)

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>
@mstomar125

Copy link
Copy Markdown
Contributor Author

APPROVE (adversarial re-review by author)

  • Behavior safety: mechanically verified the code portion of every touched line is byte-identical (1744 pure-comment changed lines + ~26 block-comment continuations / inline code; // comments with unchanged code prefixes; the single accidental log-string edit was reverted). Full pre-push gate green on the first run (test:all + cargo build --bin nodespaced + e2e + cargo test -p nodespace-app). A comment-only change cannot alter compilation or behavior.
  • Rewording quality: sampled across all four package groups — ADR references preserved (ADR-030 Phase 2, ADR-046), parentheticals closed, section-header rules cleaned, and content-bearing doc comments kept their prose (e.g. the SkillPipeline module doc lost only its Issue #1130: prefix). Checked for dangling connectives ("fixes from", trailing "See"/"per") — the candidates are all natural mid-sentence line wraps with real continuations, not orphans.
  • No false edits: issue numbers inside string literals, assertion/log messages, test titles, fixtures, CSS hex colors, and #[...] attributes were left intact; an upstream tauri-apps/tray-icon reference was reduced to prose rather than linked by number.
  • Completeness: a repo-wide grep confirms zero GitHub issue-number references remain on comment lines across all packages; the residual matches are exactly the deliberately-left false positives above.
  • Out of scope (noted in the PR): quality:fix fails on a pre-existing import_service.rs:645 clippy warning present on clean main, unrelated to this sweep.

Meets the acceptance criteria for the comment sweep.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove issue-number references from nodespace-core code comments and docs

1 participant