Skip to content

chore: remove unnecessary comments under ADR 0110 - #188

Merged
kyle-sexton merged 1 commit into
mainfrom
chore/remove-unnecessary-comments
Nov 21, 2026
Merged

kyle-sexton merged 1 commit into
mainfrom
chore/remove-unnecessary-comments

Conversation

@kyle-sexton

Copy link
Copy Markdown
Member

Refs: melodic-software/control-hub#12

Summary

Comment-removal sweep of melodic-software/cursor-plugins under ADR 0110 (necessary posture) and REVIEW.md. Code-file count: 26 tracked code files (8 sync-managed from standards including pr-review*-hosted.yml, 6 under .claude/ecosystems/, and 12 locally-owned files reviewed).

Fix

Removed 30 lines of section banners, signature restatements, and obvious step-narration comments across 3 shell scripts:

  • .cursor/install.sh: removed two # --- ... --- section banners while keeping all decision and operational rationale comments intact.
  • scripts/test-check-docs-naming.sh: removed the # run_case NAME WANT_EXIT FILE... signature restatement while keeping the header usage and exit-code contract.
  • scripts/test-sync-local.sh: removed 8 # --- ... --- section banners, pure signature restatements (assert_twins, assert_contains, assert_absent, mkplugin, mkmarket), and 5 obvious test-case/helper narration lines (clone_from_old, fast-forward, dirty checkout, --no-update, dry-run).

Preserved untouched:

  • All shebangs, #Requires, PowerShell <# ... #> comment-based help, # spellchecker:off / # spellchecker:on, # shellcheck disable=SC2016, SHA-pin version comments (# v7.0.1, # v0.78.0), sync-managed files, .github/workflows/pr-review*.yml, .claude/ecosystems/*.yaml, and all parity/security/schema decision comments across scripts/sync-local.sh, scripts/sync-local.ps1, scripts/validate-manifests.mjs, scripts/validate-environment.mjs, scripts/check-docs-naming.sh, .github/dependabot.yml, and .github/workflows/pr-require-checks.yml.

Verification

  • git diff verified strictly comment/banner deletions (3 files changed, 2 insertions(+), 30 deletions(-)), zero code tokens modified.
  • bash -n .cursor/install.sh scripts/test-check-docs-naming.sh scripts/test-sync-local.sh exited 0.
  • bash scripts/test-check-docs-naming.sh passed all 9 cases.
  • bash scripts/test-sync-local.sh passed all 41 bash assertions (0 failed; pwsh cases run in CI).
  • Full CI and review lanes verified on this PR.

Related

  • Refs: melodic-software/control-hub#12

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-21T19:56:54.869388Z 5d4ba13 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

Copy link
Copy Markdown

claude-security-review reviewed 5d4ba1315e5c4c43cf348f681fbf3f6f68588fff: 0 finding(s), 0 as inline comments.

No security findings.

The diff only deletes comment lines in .cursor/install.sh, scripts/test-check-docs-naming.sh and scripts/test-sync-local.sh, plus the trailing comment on mkplugin() and mkmarket(). It changes no executable statement, quoting, path, URL, pin, permission or manifest.

  • Skip 2 applies: the change has no security-relevant surface.
  • Instruction-surface lens: I applied it because the diff deletes text from shell files. The deleted lines are section banners and function-usage comments. None is a standing instruction to the model (CLAUDE.md, AGENTS.md, a rules file, a skill or agent body, or a hook block list), so none matches a protected class.
  • Trust controls and manifests: none are touched. No trusted-path file is in the diff.
  • Protected-class register: I did not consult docs/contracts/instruction-exception-register/README.md. Nothing in the diff needed it.

critical-findings: 0

@github-actions

Copy link
Copy Markdown

claude-review reviewed 5d4ba1315e5c4c43cf348f681fbf3f6f68588fff: 0 finding(s), 0 as inline comments.

No findings. Verifier dropped 0 of 0 candidates.

What I checked

  • I read the full diff in .claude-lane/pr.diff and the PR context. The PR has no closing issue; it only carries a Refs: line, so there are no acceptance criteria to check.
  • The change is comment-only across .cursor/install.sh, scripts/test-check-docs-naming.sh and scripts/test-sync-local.sh. The only + lines are mkplugin() { and mkmarket() {, which are the same function lines with their trailing signature comments removed. No executable token changes.
  • I checked the deletions against the REVIEW.md rule at lines 79–84: a deleted comment is flagged only when it recorded why a decision was made and that reason lives nowhere else. The removed lines are section banners, signature restatements (run_case, assert_twins, assert_contains, assert_absent, mkplugin, mkmarket) and step narration (clone_from_old, fast-forward, dirty checkout, --no-update, dry-run). None of them records a design reason.
  • The rationale comments the removals sit next to are intact: the apt-source and single-apt-get update note in install.sh, the node_modules temp-prefix note, and the per-twin clone note in the git-update tests.
  • The loosened-check criterion does not apply. Nothing in the diff weakens a test, a lint rule, a gate or a threshold. The only deleted test-suite lines are comments, and no assertion or case is removed.
  • No .claude/rules/ files matched the changed paths. I did not run the tools; the PR's verification claims (shellcheck/test results) are author-claimed and unverified by me.

Minor observation, not a finding

  • The removed assert_twins <name> <expected-exit> <sh-args...> -- <ps-args...> comment was the only place that spelled out the -- argument-split convention. The call sites in the file still show the convention, so I did not treat it as meeting the high-signal bar. The author could restore that one line if they want the contract documented at the definition.

manifest fields: not applicable (no plugin manifests changed).

@kyle-sexton
kyle-sexton merged commit d7f859d into main Nov 21, 2026
12 checks passed
@kyle-sexton
kyle-sexton deleted the chore/remove-unnecessary-comments branch November 21, 2026 19:58
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