Repository navigation
chore: drop bare origin-issue citations from comments and test titles - #574
Merged
Merged
Conversation
Contributor
|
Standing release PR: #582 · v0.41.1 queued (4 packages) · open 3m · ✅ ready to merge Release Preview — v0.41.0 → v0.41.1
These changes will be added to the release PR (#582) when merged: Changelogmonorepo 0.41.0 → 0.41.1
After merge — predicted release
Updated automatically by ReleaseKit |
This was referenced Jul 19, 2026
Closed
Closed
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
force-pushed
the
chore/drop-origin-issue-citations
branch
from
July 19, 2026 21:10
14d22f2 to
8107bc4
Compare
Merged
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.
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
#NNNtags 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/
describetitles 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:
(#NNN review)provenance.#123/#NNN/#88refs that are example data in ref-parsing regexes.#372= strictReachable-abort) and mid-sentence refs where the number is part of the meaning.Breakdown
#569tags that landed on main via #570)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### Commentsrules (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
#NNNorigin-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.#NNNtags stripped from JSDoc and inline comments inchangelogRefs.ts,types.ts,commitParser.ts,git-push.ts, and others — the prose remains complete and self-explanatory without the citation.describe/itstrings 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
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]%%{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]Reviews (2): Last reviewed commit: "chore: drop bare origin-issue citations ..." | Re-trigger Greptile