Skip to content

chore: trim comments to the load-bearing ones - #723

Merged
goosewobbler merged 1 commit into
mainfrom
chore/comment-cleanup
Oct 23, 2026
Merged

goosewobbler merged 1 commit into
mainfrom
chore/comment-cleanup

Conversation

@goosewobbler

@goosewobbler goosewobbler commented Oct 23, 2026 •

Copy link
Copy Markdown
Owner

Repo-wide comment pass against these rules: keep only comments a competent reader couldn't infer from the code. Cut restatements, test narration, section banners, history and repeated caveats. Tighten what's left and move line-specific notes inline.

  • 313 files, +1.8k / −7.6k lines, comments only. I checked this mechanically: each changed TS/JS file has an identical comment-stripped token stream vs main, and the YAML parses identically once shell comments are ignored. The one exception is a trailing comma Biome dropped in packages/version/vitest.config.ts after its inline comment went.
  • Wrong or stale comments corrected or dropped. Examples: sync: true described as running through the group engine (it uses the sync strategy); RELEASE_NOTES.md (notes are now per-version files); a "keep in sync with generate-schema.ts" note (the schema is generated from Zod); comments naming functions/fields that no longer exist.
  • Other rules applied. Load-bearing issue refs became full URLs, history-only refs were dropped, emdashes became hyphens, and prose + became &.
  • Left alone. Directives (biome-ignore, eslint-disable, @internal, @deprecated), pinned-action version comments, string literals and .describe() text.

Conflicts with #721 in a few files; whichever merges second needs a rebase.

🤖 Generated with Claude Code

RetriggerView in GreptileConfidence Score: 5/5

The PR appears safe to merge; no actionable issues were found.

Summary

Trims comments across 313 files, removing repeated explanations, test narration, section headings, and stale history.

  • Releasekit comments now focus on context the code cannot show.

Reviews (1) · Last reviewed commit: "chore: trim comments to the load-bearing..." · Reviewed by Greptile

@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

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

Release Preview — v0.42.0 → v0.42.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 (#730) when merged:

Changelog

monorepo 0.42.0 → 0.42.1

Changed

  • trim comments to the load-bearing ones

All packages → 0.42.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.42.1 0.42.1 0.42.1

Updated automatically by ReleaseKit

Repo-wide comment pass: drop comments that restate the code, narrate tests,
record history or repeat a caveat stated elsewhere; tighten the rest; move
line-specific notes inline. Stale and incorrect comments are removed or
corrected, load-bearing issue refs become full URLs, and emdashes become
hyphens. Comments only - no code changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@goosewobbler
goosewobbler force-pushed the chore/comment-cleanup branch from 1f58883 to 7d7da1c Compare October 23, 2026 18:30
@goosewobbler
goosewobbler merged commit 3f17eae into main Oct 23, 2026
33 checks passed
@goosewobbler
goosewobbler deleted the chore/comment-cleanup branch October 23, 2026 18:35
@github-actions github-actions Bot mentioned this pull request Oct 23, 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