Skip to content

chore: drop devcontainer comments that only repeat the line below - #198

Merged
gatezh merged 2 commits into
masterfrom
chore/trim-devcontainer-comments
Oct 8, 2026
Merged

gatezh merged 2 commits into
masterfrom
chore/trim-devcontainer-comments

Conversation

@gatezh

@gatezh gatezh commented Oct 6, 2026 •

Copy link
Copy Markdown
Owner

What

Removes the devcontainer.json comments that only repeat the line below them.

Why

Lines like // Show workspace folder name in window title above "window.title", or // Configure properties specific to VS Code. above "vscode", add nothing. Projects copy these files, so the noise spreads downstream.

Changes

  • Removed (23 lines across eight files):
    • window title, extension recommendations (the plain variant), and customizations / vscode boilerplate
    • "Persist … between container rebuilds" above those volumes
    • "Format on save with Biome", "Biome auto-fix on save", "Allow Claude Code to skip permission prompts"
    • "Mount firewall script…", "Initialize firewall…", "Firewall locks down the network"
  • Kept as they are: extension descriptions, the formatter hint, section headers, and every comment that gives a reason, an issue number, or an instruction for template adopters.
  • .claude/rules/devcontainer.md: a short Comments section. Skip a comment that only repeats the line below it; extension descriptions are not that.

Notes

No behavior change: only comment lines are removed.

Verification

  • All eight devcontainer.json files parse as JSONC (comments and trailing commas stripped, then JSON.parse).
  • git diff master shows only the 23 removed comment lines and the rule addition.

gatezh added 2 commits October 6, 2026 13:42
Per-extension descriptions repeat the extension ID, and many setting and
mount comments repeat the key below them. Keep the ones that say why, give
an issue number, or tell a template adopter what to change. The
devcontainer.json rule now says so, since it was the source of the
per-extension descriptions.
…ents

Narrow the cleanup to comments that only repeat the line below them.
Extension descriptions, the formatter hint, section headers and the
explanatory comments return as they were on master.
@gatezh gatezh changed the title chore: drop devcontainer comments that restate the config chore: drop devcontainer comments that only repeat the line below Oct 6, 2026
@gatezh
gatezh merged commit 8989499 into master Oct 8, 2026
15 checks passed
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