Skip to content

chore: remove unnecessary comments under ADR 0110 - #281

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

kyle-sexton merged 2 commits into
mainfrom
chore/remove-unnecessary-comments

Conversation

@kyle-sexton

@kyle-sexton kyle-sexton commented Nov 21, 2026 •

Copy link
Copy Markdown
Member

Refs: melodic-software/control-hub#12

Summary

Pilot sweep of melodic-software/.github under ADR 0110 (necessary posture) and the decision-comment review criterion in REVIEW.md. Code-file count: 31 tracked code files in the repository (12 sync-managed from standards including pr-review*.yml, 5 under .claude/ecosystems/, and 14 locally-owned scripts/workflows/configs reviewed).

Fix

Removed 60 lines of redundant narration, section banners, and file-header summaries that duplicate README.md or immediately adjacent code across 5 locally-owned files:

  • .cursor/check.sh: removed redundant file-summary lines, obvious $HOME/.local/bin fallback comment, run_lane restatement, and three section banners (# --- ... ---).
  • .cursor/install.sh: removed file-summary header already documented in README.md, variable-init narration, signature line above verify_sha (keeping its fail-closed rationale), and restatement comments above resolve_install_prefix, ensure, and install_release.
  • .cursor/install-prefix.test.sh: removed redundant file-summary header and mock-restatement comment.
  • .github/scripts/issue-form-drift.mjs: removed file-summary header duplicating README.md / CONTRACT_FOOTER and return-shape restatement above parseForm.
  • .github/scripts/pr-section-drift.mjs: removed restatement comment above parseSourceControlSections.

Preserved rationale moved from the removed .cursor/install.sh file header into this squash-merge commit message:

  • .cursor/install.sh: Cloud Agent installs into /usr/local/bin (MELODIC_HYGIENE_SYSTEM=1) because /usr/local/bin is already on the agent shell PATH; every downloaded release asset is verified against the same SHA-256 the CI composite action pins so local runs fail closed and match CI byte for byte.

Preserved untouched in code:

  • All shebangs (#!/usr/bin/env bash, #!/usr/bin/env node), lint/schema directives (# shellcheck disable=SC2310, # shellcheck source=install.sh, # yaml-language-server), and SHA-pin version comments (# v7.0.1, # v0.78.0).
  • All sync-managed files, .github/workflows/pr-review*.yml, and .claude/ecosystems/*.yaml.
  • All non-obvious decision, invariant, constraint, and external-contract comments (including .cursor/install.sh's fail-closed verify_sha rationale, test seam, and sudo secure_path / python3-venv notes; .cursor/check.sh's Not set -e, typos hidden-file handling, and lane_eol worktree isolation; .github/scripts/issue-form-drift.mjs's YAML-subset line-reader rationale; .github/scripts/pr-section-drift.mjs's ADR-0008 / parseCompositeSections coupling; and all .github/workflows/pr-require-checks.yml and .github/dependabot.yml invariant comments).

Verification

  • git diff verified strictly comment/blank-line deletions (5 files changed, 60 deletions(-)), zero code tokens modified.
  • bash -n .cursor/check.sh .cursor/install.sh .cursor/install-prefix.test.sh exited 0.
  • bash .cursor/install-prefix.test.sh printed ok and exited 0.
  • actionlint -color .github/workflows/pr-require-checks.yml .github/workflows/pr-automerge-dependabot.yml exited 0.
  • Full CI hygiene suite and review lanes verified on this PR.

Related

  • Refs: melodic-software/control-hub#12 (pilot repository before sweeping the remaining small repositories)

@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:38:42.533526Z 98ff787 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.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 98ff787958

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .cursor/install.sh Resolved
@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

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

Incremental security review of .cursor/install.sh (since 98ff787). The only change is a three-line comment above verify_sha() explaining that the install aborts on a checksum mismatch. No executable code, pin, checksum, trust control, or workflow changed, so the change has no security surface (skip gate 2).

The change touches no trust control, manifest, or instruction surface. The comment describes the existing behavior, and the verify_sha logic is unchanged.

critical-findings: 0

Comment thread .cursor/install.sh Resolved
@github-actions

github-actions Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

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

Incremental review of .cursor/install.sh (since 98ff787): the only change is a 3-line comment above verify_sha that restores its fail-closed rationale. No code tokens changed.

I read the function at head. It calls exit 1 on a SHA-256 mismatch, so the comment's "abort the whole install" matches the code. It adds a decision rationale rather than narrating the code, which fits the PR's stated aim of keeping non-obvious rationale. I found nothing to report. I did not run the author's claimed bash -n or test-script checks.

Loosened checks: no consumer entries or verdict were supplied by the wrapper, so I used fail with no consumer entries. The diff is comment-only and loosens nothing. The decision-record citation requirement was not checked.

Closing issue: the PR uses Refs: and closes nothing, so there are no acceptance criteria to check.

Verifier dropped 0 of 0 candidates.

Preserved rationale from .cursor/install.sh header: Cloud Agent installs into /usr/local/bin because it is already on the agent shell PATH, and release assets are verified against the same SHA-256 the CI composite action pins.
@kyle-sexton
kyle-sexton merged commit 8f0341b into main Nov 21, 2026
40 of 41 checks passed
@kyle-sexton
kyle-sexton deleted the chore/remove-unnecessary-comments branch November 21, 2026 19:45
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