New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

You Might Not Need A Comment

by simstudioai in simstudioai/sim

Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc

Apache-2.0Auto-check passedDevelopment

Install You Might Not Need A Comment

skills CLI
$ npx skills add simstudioai/sim --skill you-might-not-need-a-comment -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install simstudioai/sim you-might-not-need-a-comment --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/simstudioai/sim.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/you-might-not-need-a-comment .claude/skills/you-might-not-need-a-comment && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
you-might-not-need-a-comment
GitHub stars
30k
Token cost
~947 tokens
SKILL.md length
479 words
Files
1
Skills in repo
40
Repo updated
First seen
Licence
Apache-2.0

At a glance

Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc

  • Works in 7 steps: Restates the code: // increment counter… → Narrates the obvious from names: the… → Section-divider / banner comments: //… → …
  • Tasks that involve Technical documentation
  • SKILL.md covers The one rule that matters, Anti-patterns to detect, Patterns that ARE correct — do… and Bias, plus 1 more section
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

You Might Not Need A Comment is an agent skill from simstudioai/sim. Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc

Its SKILL.md is about 950 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: Sim is the collaborative workspace to build, deploy, and monitor AI agents and workflows. Used by 100,000+ builders. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/you-might-not-need-a-comment”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. Restates the code: // increment counter above counter++, // return the result above return result, // loop over items. Delete.
  2. Narrates the obvious from names: the function is fetchUserById, the comment says // fetches a user by id. The identifier already said it…
  3. Section-divider / banner comments: // ==== Helpers ====, // --- state ---, // #region. Against convention. Delete (the code's structure is…
  4. Commented-out code: dead code left as a comment. Delete — git is the history.
  5. Redundant type/param echo in prose comments: // takes a string and returns a number when the signature already says so. Delete.
  6. Changelog / attribution noise: // added by X, // TODO(2021): ... long-stale, // fix for bug. Delete unless it encodes a live, actionable…
  7. Genuine documentation written as a loose // block on a declaration: a real explanation of what an exported function/type/const is for, but…

What it can do on your machine

Read from SKILL.md and the folder at commit 546d4e7. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

You Might Not Need A Comment loads about 947 tokens when it runs. Until then it costs about 36 tokens; SKILL.md has 479 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~36
When it runs · the whole SKILL.md, loaded when a task matches
~947

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from simstudioai/sim at commit 546d4e7, republished under its Apache-2.0 licence (© simstudioai). 479 words, ~947 tokens.

Download SKILL.mdSave it as .claude/skills/you-might-not-need-a-comment/SKILL.md (or your agent's skills folder).
name
you-might-not-need-a-comment
description
Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc
argument-hint
[scope] [fix=true|false]

You Might Not Need a Comment

Arguments:

  • scope: what to analyze (default: your current changes). Examples: "diff to main", "PR #123", "src/components/", "whole codebase"
  • fix: whether to apply fixes (default: true). Set to false to only propose changes.

User arguments: $ARGUMENTS

The one rule that matters

A comment must add information the code cannot express itself. Code says what and how; a comment earns its place only by explaining why — a non-obvious constraint, a workaround, a decision, a gotcha. If deleting the comment loses no information a competent reader wouldn't recover from the code in seconds, delete it.

This codebase's convention: TSDoc for documentation; an inline // only for a terse non-obvious why or a script-enforced annotation; no ==== separators. Genuine documentation belongs in a /** ... */ block on the declaration; everything that survives as an inline // comment must be a real why, kept terse.

Anti-patterns to detect

  1. Restates the code: // increment counter above counter++, // return the result above return result, // loop over items. Delete.
  2. Narrates the obvious from names: the function is fetchUserById, the comment says // fetches a user by id. The identifier already said it. Delete.
  3. Section-divider / banner comments: // ==== Helpers ====, // --- state ---, // #region. Against convention. Delete (the code's structure is the structure).
  4. Commented-out code: dead code left as a comment. Delete — git is the history.
  5. Redundant type/param echo in prose comments: // takes a string and returns a number when the signature already says so. Delete.
  6. Changelog / attribution noise: // added by X, // TODO(2021): ... long-stale, // fix for bug. Delete unless it encodes a live, actionable constraint.
  7. Genuine documentation written as a loose // block on a declaration: a real explanation of what an exported function/type/const is for, but written as stacked // lines instead of TSDoc. Convert to a /** ... */ TSDoc block on the declaration.
Show full SKILL.md (185 more words)Show less

Patterns that ARE correct — do not flag

  • A // comment that explains a non-obvious why: a workaround for an upstream bug, an ordering constraint, a perf reason, a spec/edge-case the code can't self-document (// first-match wins — matches the old find() semantics).
  • Existing TSDoc /** ... */ blocks on declarations — leave them (only tighten if verbose).
  • // boundary-raw-fetch:, // double-cast-allowed:, // boundary-raw-json:, // untyped-response:, -- migration-safe: (SQL migrations), // rq-lint-allow:, // client-boundary-allow: and any other <kebab-tag>: <reason> annotation a script under scripts/ greps for, in line-comment or block-comment form (e.g. the /** svg-path-precision-exception: ... */ directive on icon paths) — these are load-bearing, never touch them.
  • // biome-ignore, // eslint-disable, // @ts-expect-error and other tooling directives.
  • // TODO / // FIXME that point at real, still-open work.

Bias

Prefer deletion over rewriting, and no comment over a comment when the code is already clear. When a comment is genuine documentation, prefer promoting it to terse TSDoc over leaving a loose // block. Never add new comments in this pass — this is a reduction pass. When unsure whether a comment encodes a real why, keep it.

Steps

  1. Analyze the specified scope for the anti-patterns listed above
  2. If fix=true, apply the fixes. If fix=false, propose the fixes without applying.

© simstudioai, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/you-might-not-need-a-comment of simstudioai/sim.

Open the folder on GitHubat commit 546d4e7

Compare with similar skills

You Might Not Need A Comment next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

You Might Not Need A Comment compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
You Might Not Need A Comment this skillsimstudioai/sim30k—~947Automated safety check: PassApache-2.0
Diagram Designcathrynlavery/diagram-design44k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.4kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    44k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed

  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.4k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from simstudioai/sim

All 40 skills in this repo

  • Sim Helm

    simstudioai/sim

    Install, upgrade, and operate the Sim Helm chart on Kubernetes.

    30k GitHub stars~2.2k tokensUpdated today
    Auto-check passed

  • Add Column Type

    simstudioai/sim

    Add a new table column type to Sim — registry entry, icon, storage shape, coercion, and the behavioral hooks the grid and API read.

    30k GitHub stars~2.9k tokensUpdated today
    Auto-check passed

  • Add Enrichment

    simstudioai/sim

    Add a code-defined table enrichment (registry entry) under apps/sim/enrichments/ backed by an ordered provider cascade, ensuring every provider tool it calls has hosted-key support.

    30k GitHub stars~2.2k tokensUpdated today
    Auto-check passed

  • Add Hosted Key

    simstudioai/sim

    Add hosted API key support to a tool so Sim provides the key (metered and billed to the workspace) when a user has not brought their own.

    30k GitHub stars~3.4k tokensUpdated today
    Auto-check passed

  • Add Managed CLI

    simstudioai/sim

    Add or upgrade a curated, immutable managed CLI for Sim Function sandboxes, including client-safe catalog metadata, a pinned server-only installation recipe, checksum and executable verification…

    30k GitHub stars~2.4k tokensUpdated today
    Auto-check passed

  • Add Selector

    simstudioai/sim

    Add or update a Sim dynamic selector using the shared manifest, server attachment, and selectors.execute path.

    30k GitHub stars~1.7k tokensUpdated today
    Auto-check passed

Categories

Questions about You Might Not Need A Comment

What does You Might Not Need A Comment do?

Analyze and fix redundant or self-explanatory inline comments — remove noise, promote genuine documentation to TSDoc. You Might Not Need A Comment is an agent skill from simstudioai/sim.

When should I use You Might Not Need A Comment?

You Might Not Need A Comment fits situations like: tasks that involve Technical documentation.

How do I install You Might Not Need A Comment in Claude Code?

Run `npx skills add simstudioai/sim --skill you-might-not-need-a-comment -a claude-code`. Or copy the skill folder (.agents/skills/you-might-not-need-a-comment in simstudioai/sim) into .claude/skills/you-might-not-need-a-comment in your project. Claude Code loads it when a task matches its description.

How do I install You Might Not Need A Comment in Codex?

Run `npx skills add simstudioai/sim --skill you-might-not-need-a-comment -a codex`. Or copy the skill folder (.agents/skills/you-might-not-need-a-comment in simstudioai/sim) into .agents/skills/you-might-not-need-a-comment in your project. Codex loads it when a task matches its description.

Can I use You Might Not Need A Comment in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add simstudioai/sim --skill you-might-not-need-a-comment -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/you-might-not-need-a-comment, .gemini/skills/you-might-not-need-a-comment, .github/skills/you-might-not-need-a-comment and .opencode/skills/you-might-not-need-a-comment in your project.

What does You Might Not Need A Comment need to run?

SKILL.md names no scripts, command-line tools or credentials: You Might Not Need A Comment is instructions for the agent only.

Does You Might Not Need A Comment access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is You Might Not Need A Comment safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does You Might Not Need A Comment use?

You Might Not Need A Comment is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does You Might Not Need A Comment use?

About 947 tokens (SKILL.md is roughly 3.8k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to You Might Not Need A Comment?

Skills that share tags, products or a category with You Might Not Need A Comment: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains You Might Not Need A Comment?

simstudioai (a GitHub organization) maintains it in simstudioai/sim, which has 29,785 GitHub stars. The repository holds 40 skills in this directory. The repository was last updated on October 7, 2026.

Source: simstudioai/sim on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.