(janitor/comments): remove noise comments from platform integrations - #6884
Merged
Merged
Conversation
Delete restating JSDoc, section banners, numbered step narration, and duplicated @PARAM boilerplate from the GitHub/GitLab platform adapters and webhook handlers. Comments carrying real constraints - external API behavior, fail-open choices, ledger/authorization invariants, @see references, lint directives - are kept.
Contributor
Author
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Executive SummaryThis PR contains only comment and blank-line deletions across the GitHub/GitLab platform integration area; I verified the diff removes no executable code, no JSDoc that tooling or the type-checker depends on, and no constraint-bearing rationale, so there is no behavioral or security impact. Files Reviewed (16 files)
Verification performed
Reviewed by deepseek-v4.1-flash · Input: 0 · Output: 0 · Cached: 0 Review guidance: REVIEW.md from base branch |
pandemicsyn
approved these changes
Sep 29, 2026
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
1 participant
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.
Package or topic area cleaned
apps/web/src/lib/integrations/platforms/— the third-party platform adapters and webhook handlers (GitHub, GitLab, Bitbucket, Slack). This area had the highest concentration of pre-hygiene comment styles in the repo: function-name-restating JSDoc, section banners, numbered step narration, and@paramboilerplate repeated verbatim across ~40 call sites.Files touched (16)
github/adapter.ts,github/app-selector.ts,github/webhook-handler.ts,github/webhook-helpers.ts,github/webhook-schemas.tsgithub/webhook-handlers/{index,installation-repositories-handler,issue-handler,pull-request-handler}.tsgithub/webhook-handlers/{pull-request-handler.test,upsert-cli-session-pull-requests.test}.tsgitlab/adapter.ts,gitlab/webhook-sync.ts,gitlab/webhook-schemas.tsgitlab/webhook-handlers/{index,merge-request-handler}.tsComment lines removed
587 comment lines (1,637 → 1,050 in the area); 16 files, 645 deleted diff lines, 38 retained/trimmed comment lines. Diff contains only comment and blank-line changes.
Categories of noise removed
Verifies GitHub webhook signatureaboveverifyGitHubWebhookSignature,GitLab Project Webhook typeabovetype GitLabWebhook)@param/@returnsboilerplate restating parameter names and defaults (@param appType - The type of GitHub App to use (defaults to 'standard')×15,@param accessToken - OAuth access token×20+)// ==== Webhook Verification ====,// Commit Inspection,// Project Access Token (PrAT) Management, …)// 1. Verify signature,// 5. Route based on event type,// 7. Create review record)// Filter out archived repositories,// Sort by updated_at descending and pick the latest,// Handle timeout,// Debug: Log integration fields)pull-request-handler.ts)Important comments intentionally retained
errorbody for OAuth failures, 409 = "Git Repository is empty", PrAT token only present on creation, GitLab 14.0+ requirement forpersonal_access_tokens/self, 1-year PrAT expiry capinstallation-handler.ts,webhook-handler.ts(delivery-envelope-only capture, suspend/unsuspend tenant resolution, dedup ordering)@seedoc links,@throwscontracts, eslint directives, and the integration-lock/serialisation invariantsFollow-up refactor candidates
None. Every deleted comment's information was either restated by the code or duplicated by a retained comment; nothing required restructuring to stay understandable.
Validation performed
oxlintonapps/web/src/lib/integrations/platforms: 0 warnings, 0 errorsoxfmt --list-differenton the area: cleantsgo --noEmitforapps/web: exit 0AggregateErrorfrom network/DNS-restricted test setup — e.g. the SSRF-guard DNS resolution ininstance-url); verified viagit stashthat the failures pre-exist. Comment-only changes cannot alter test behavior.