Skip to content

chore: drop bare origin-issue citations from comments and test titles - #574

Merged
goosewobbler merged 1 commit into
mainfrom
chore/drop-origin-issue-citations
Jul 19, 2026
Merged

goosewobbler merged 1 commit into
mainfrom
chore/drop-origin-issue-citations

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Jul 19, 2026 •

Copy link
Copy Markdown
Owner

Follow-up to the #571/#569 discussion: a repo-wide, narrow cleanup of bare origin-issue citations. Related: #573 (the hyperlink/AGENTS.md follow-up).

What

Removes 80 trailing #NNN tags that merely cited the issue/PR a piece of code closed or a test covers, where the comment or test title already stands on its own:

  • // …undercounted the standing-PR preview. #569 → // …undercounted the standing-PR preview.
  • it('should honour an authorized actor's channel toggle (#526)') → it('should honour an authorized actor's channel toggle')

80 insertions / 80 deletions across 26 files — every change is a single-line, citation-only removal. Comments and test/describe titles only; no behavior change.

Why

A bare number isn't actionable — not clickable in a comment or in test-reporter/CI output, and in-source it's largely redundant with git blame → PR → issue (the canonical trace). Low value for human readers, marginal-and-redundant for LLMs.

Deliberately kept (not touched)

Classified per-package with a conservative "when in doubt, keep" rubric:

  • Load-bearing tracking refs ("until #X", "remove when #X").
  • (#NNN review) provenance.
  • Illustrative #123 / #NNN / #88 refs that are example data in ref-parsing regexes.
  • Cross-file decision-shorthand (e.g. #372 = strictReachable-abort) and mid-sentence refs where the number is part of the meaning.

Breakdown

Package Drops
release 53
core 8
notes 8
version 6 (incl. the 3 #569 tags that landed on main via #570)
publish 3
scripts 2

Verification

pnpm turbo run lint typecheck test — 32/32 tasks green. Artifact scan confirms no double-periods, empty parens, or dangling punctuation; kept refs verified still present.

Follow-up (#573)

Convert the kept refs to explicit hyperlink comments (// … See <url>) and codify the convention in AGENTS.md's ### Comments rules (kept refs = hyperlinks not bare numbers; drop bare origin citations; titles stay ref-free).

🤖 Generated with Claude Code

Greptile Summary

This PR performs a narrow, mechanical cleanup across 26 files, removing 80 bare trailing #NNN origin-issue citations from source comments and test/describe titles where the surrounding text already stands on its own. No logic, behavior, or configuration is modified.

  • Comments: Trailing #NNN tags stripped from JSDoc and inline comments in changelogRefs.ts, types.ts, commitParser.ts, git-push.ts, and others — the prose remains complete and self-explanatory without the citation.
  • Test titles: describe/it strings have their parenthesized issue refs removed across the release, notes, publish, version, and core test suites; section-header comments and mid-sentence/illustrative refs were deliberately left untouched per the stated "when in doubt, keep" rubric.

Confidence Score: 5/5

Pure cosmetic cleanup with no behavior change — every edit is a single-line removal of a trailing issue citation from a comment or test title, and the PR verification confirms lint, typecheck, and all 32 test tasks pass green.

Every changed line is a deletion of a bare #NNN tag from prose; no logic, types, exports, or test assertions are altered. The conservative keep-if-in-doubt rubric the author applied is visible in the diff — mid-sentence refs, section-header comments with ---, and regex example data are all preserved. There is nothing here that could introduce a regression.

No files require special attention.

Important Files Changed

Filename Overview
packages/release/test/unit/standing-pr.spec.ts Largest single file change (26 it/describe title cleanups); all assertion bodies are unchanged.
packages/release/test/unit/selection-region.spec.ts Removed citations from describe/it titles; section-header comments were correctly left untouched.
packages/core/src/types.ts Removed trailing #468 and #485 citations from JSDoc; mid-sentence #486 ref left intact per the stated rubric.
packages/core/src/changelogRefs.ts Removed three trailing #507/#499 citations from JSDoc and inline comments; prose remains self-contained.
packages/version/src/changelog/commitParser.ts Removed trailing #522 and #569 citations from two inline comments; no logic changed.
packages/publish/src/stages/git-push.ts Removed single trailing #429 citation from an inline comment; no behavior change.
scripts/examples-smoke/generate-smoke-workflow.ts Removed 'issue #276' citation from the file-level JSDoc; description remains clear.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR #574: Drop bare origin-issue citations] --> B{Citation type?}
    B -->|Trailing bare ref in comment| C[Remove citation]
    B -->|Parenthesized ref in test title| D[Remove citation]
    B -->|Load-bearing tracking ref| E[Keep — not touched]
    B -->|Mid-sentence / part of meaning| E
    B -->|Illustrative example data in regex/fixtures| E
    B -->|Section-header comment with dashes| E
    C --> F[80 single-line deletions across 26 files]
    D --> F
    F --> G[No behavior change — lint + typecheck + 32 tests green]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[PR #574: Drop bare origin-issue citations] --> B{Citation type?}
    B -->|Trailing bare ref in comment| C[Remove citation]
    B -->|Parenthesized ref in test title| D[Remove citation]
    B -->|Load-bearing tracking ref| E[Keep — not touched]
    B -->|Mid-sentence / part of meaning| E
    B -->|Illustrative example data in regex/fixtures| E
    B -->|Section-header comment with dashes| E
    C --> F[80 single-line deletions across 26 files]
    D --> F
    F --> G[No behavior change — lint + typecheck + 32 tests green]
Loading

Reviews (2): Last reviewed commit: "chore: drop bare origin-issue citations ..." | Re-trigger Greptile

@goosewobbler goosewobbler added this to the 0.41.0 milestone Jul 19, 2026
@github-actions

github-actions Bot commented Jul 19, 2026 •

Copy link
Copy Markdown
Contributor

Standing release PR: #582 · v0.41.1 queued (4 packages) · open 3m · ✅ ready to merge

Release Preview — v0.41.0 → v0.41.1

Note: Labels on this PR are advisory in standing-pr mode. Bumps come from conventional commits in the standing PR; override by editing labels on the standing PR itself. Add release:immediate to bypass the standing PR and release this PR directly.

These changes will be added to the release PR (#582) when merged:

Changelog

monorepo 0.41.0 → 0.41.1

Changed

  • drop bare origin-issue citations from comments and test titles

All packages → 0.41.1 (sync versioning)

  • @releasekit/version
  • @releasekit/notes
  • @releasekit/publish
  • @releasekit/release

After merge — predicted release

No version escalation — this PR's changes will be included in the queued release without affecting the projected versions.

Package Standing PR This PR After merge
monorepo 0.41.1 0.41.1 0.41.1

Updated automatically by ReleaseKit

Remove ~80 trailing #NNN tags that merely cited the issue/PR a piece of
code closed or a test covers, where the comment or title already stands on
its own (e.g. `// ...preview. #569`, `it('should ... (#486)')`). Git
history remains the canonical code<->issue trace, and a bare number isn't
actionable in a comment or test-reporter output anyway.

Deliberately kept: load-bearing tracking refs (until/remove-when), `(#NNN
review)` provenance, illustrative `#123`/`#NNN` regex examples, and
cross-file decision-shorthand refs. Comments-only touch — no behavior
change; 80 insertions / 80 deletions, all single-line.

Follow-up in #573: convert the kept refs to explicit hyperlink comments
and codify the convention in AGENTS.md.
@goosewobbler
goosewobbler force-pushed the chore/drop-origin-issue-citations branch from 14d22f2 to 8107bc4 Compare July 19, 2026 21:10
@goosewobbler
goosewobbler merged commit 3cea584 into main Jul 19, 2026
34 checks passed
@goosewobbler
goosewobbler deleted the chore/drop-origin-issue-citations branch July 19, 2026 21:20
@github-actions github-actions Bot mentioned this pull request Jul 19, 2026
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.

1 participant